Autenticación
Autoinspector autentica tus solicitudes de API usando las api keys de tu empresa. Si no incluyes tu clave al hacer la solicitud o usas una clave incorrecta o desactualizada, Autoinspector devuelve un código de respuesta http 401 - Unauthorized.
Claves de API
Todas las empresas registradas en la plataforma Autoinspector cuentan con dos claves: una clave para el modo de testing o prueba y otra para el modo live o producción. Puedes encontrar tus claves de API en la pagina desarrolladores.
| TIPO | TOKEN DE EJEMPLO | CUANDO USAR |
|---|---|---|
| Api Key Test | ai_test_2FlPwm1bqSFKU6n0oEasdDdMl8R | Cuando necesites testear tu implementación con Autoinspector API y no deseas consumir inspecciones que modifiquen la facturación de tu empresa |
| Api Key Live | ai_live_2FlPwiy94psZQPF2paAHuSUPhER | Cuando tu implementación se encuentra lista para producción y deseas crear inspecciones a gran escala |
API KEY test
Usa las claves de API de test o prueba solo para tareas de desarrollo. De esta manera, no modificarás sin querer la cantidad de inspecciones consumidas de tu empresa.
Anular Claves de API
Si perdiste alguna clave secreta o la misma se ve comprometida, tienes que revocar ("anular") la clave para bloquear cualquier solicitud de la API que pueda usar esa clave. Para revocar tu clave secreta de API y generar una nueva, sigue estos pasos:
- Abre la pagina desarrolladores en el Dashboard
- En la sección API Keys, haz click sobre el botón que posee un icono con dos flechas en orientaciones opuestas
- Confirma que deseas revocar (anular) las claves de API
Cómo proteger tus claves
Tu clave secreta de API se puede utilizar para hacer llamadas a la API en nombre de tu empresa y miembros, por ejemplo, para crear inspecciones. Trata tu clave secreta de API como si fuera una contraseña.
Ejemplo de petición con autenticación
curl https://insurama.api.autoinspector.ai/v2/inspection \ --request POST \ --header 'Content-Type: application/json' \ --header 'x-api-key: YOUR_SECRET_TOKEN' \ --header 'Idempotency-Key: 882fb7ea-a75b-458e-a4c6-0814427608f8' \ --data '{ "templateId": "60f021d61234567890000666", "assets": [ { "identifier": "input_528088f5-e28d-4c2c-adf9-f0f67c4bc28a", "type": "select", "value": "option_1" }, { "identifier": "input_d6dae0fb-03c1-47c1-b6a2-d12eda8dbaff", "type": "numeric", "value": 100 } ], "notifications": [ { "channel": "wsp", "recipient": "+543812453820" }, ], "metadata": { "sinister_id": "1234567890", "policy_id": "5912" }}''