Autenticación
El Reigniter API utiliza API claves. Cada clave pertenece a una cuenta y actúa como esa cuenta: gasta los créditos de esa cuenta y solo ve los trabajos de esa cuenta.
Crear una clave
Sección titulada «Crear una clave»API llaves forman parte del plan Agency.
- Inicia sesión para Reigniter.
- Abrir > API Cuenta
/app/account/api-keys - En Crear nueva clave, escribe una etiqueta que reconozcas más adelante, como
CI pipelineoCMS sync. - Selecciona Crear.
- Copia la clave inmediatamente.
Una clave se ve así: emp_ seguida de 64 caracteres hexadecimales.
Envía la llave
Sección titulada «Envía la llave»Coloca la clave en la cabecera de Authorization como un token portador en cada solicitud:
curl https://reigniter.ai/v1/me \ -H "Authorization: Bearer $REIGNITER_API_KEY"Una clave válida devuelve 200 con tu cuenta:
{ "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21", "name": "Sam", "credits_remaining": 42}Cuando se niega una llave
Sección titulada «Cuando se niega una llave»| Estado | code |
Significado |
|---|---|---|
401 |
NO_API_KEY |
No hay Authorization cabecera, o el token no empieza con emp_. |
401 |
INVALID_API_KEY |
La clave es desconocida o ha sido revocada. |
402 |
PLAN_UPGRADE_REQUIRED |
La clave es válida, pero la cuenta no está en el plan Agency. |
403 |
ACCOUNT_SUSPENDED |
La cuenta que posee la clave queda suspendida. |
Si una cuenta sale del plan Agency, sus claves dejan de funcionar hasta que vuelve a estar en Agency.
Mantén las llaves en secreto
Sección titulada «Mantén las llaves en secreto»- Guarda las claves en un gestor de secretos o en una variable de entorno. Nunca las comprometas al control de versiones.
- Llama al API solo desde tu servidor. Nunca envíes una clave en una página web o aplicación móvil. Las solicitudes del navegador a la API no están permitidas por su política CORS de todos modos.
- Usa una clave por sistema, con una etiqueta clara. Así puedes revocar una sin romper las demás.
- La pantalla de API teclas muestra cuándo se usó por última vez cada tecla. Una clave que no reconozcas, o una usada cuando no debería, debe ser revocada.
Revocar una clave
Sección titulada «Revocar una clave»- Cuenta > API llaves abiertas.
- En Claves Activas, busca la clave junto a su etiqueta.
- Selecciona el icono de Revocar clave (bin).
Una clave revocada se rechaza de inmediato con 401 INVALID_API_KEY. La revocación no puede deshacerse. Los renderizados que ya han comenzado con la clave siguen ejecutándose.