Saltar al contenido principal

Claves de API

Network

Las claves de API permiten que su iglesia integre Apostolic Path con sistemas externos a través de la API REST. Esta es una funcionalidad avanzada disponible exclusivamente en el plan Network.

¿Qué son las claves de API?​

Las claves de API son credenciales que permiten a aplicaciones externas acceder de forma segura a los datos de su iglesia a través de la API de Apostolic Path. Cada clave:

  • Tiene alcance limitado únicamente a los datos de su iglesia
  • Está limitada por tasa (rate-limited) para prevenir abusos
  • Es gestionable individualmente, para que pueda crear, rotar y revocar claves según sea necesario

Crear una clave de API​

  1. Navegue a Configuración > Claves de API
  2. Haga clic en Crear clave de API
  3. Ingrese un nombre para la clave (p. ej., "Integración del sitio web de la iglesia", "Panel personalizado")
  4. Haga clic en Crear
  5. Copie la clave inmediatamente — solo se mostrará una vez
precaución

Almacene su clave de API de forma segura. Solo se mostrará una vez en el momento de su creación. Si la pierde, deberá crear una nueva.

Gestionar claves de API​

La página de Claves de API muestra todas sus claves con:

  • Nombre de la clave — Su etiqueta descriptiva
  • Prefijo de la clave — Los primeros caracteres para identificarla
  • Fecha de creación
  • Último uso — Cuándo se usó la clave por última vez para una llamada a la API
  • Estado (activa o revocada)

Revocar una clave​

Si una clave se ve comprometida o ya no se necesita:

  1. Encuentre la clave en la lista de Claves de API
  2. Haga clic en Revocar
  3. La clave dejará de funcionar inmediatamente
  4. Cualquier aplicación que la use deberá actualizarse con una nueva clave

Límites de tasa (rate limiting)​

Cada clave de API tiene su propio límite de tasa para garantizar un uso equitativo y la estabilidad de la plataforma. Los límites de tasa se aplican por clave, por lo que tener varias claves le proporciona más capacidad si la necesita.

Documentación de la API​

Para obtener documentación técnica sobre los endpoints de la API, la autenticación y los formatos de datos, comuníquese con el equipo de Apostolic Path a través del canal de soporte del plan Network.