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 |
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
- Node.JS
- PHP
curl -X POST 'https://api.autoinspector.ai/v1/inspection/car' \
-H 'x-api-key: <YOUR_API_KEY_GOES_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"delivery": {
"disabled": false,
"channel": "wsp",
"destination": "3813635420",
"countryISO": "AR"
},
"locale": "es_AR",
"metadata": {
"policy_id": "5912"
},
"producer": {
"internalId": "1234"
},
"templateId": "easy",
"car": {
"plate": "AQ701ZA"
},
"consumer": {
"firstName": "John",
"lastName": "Doe",
"identification": "44188219",
"email": "john@doe.com"
}
}'
const Autoinspector = require('autoinspector')
const autoinspector = new Autoinspector({
apikey: 'YOUR_API_KEY',
})
$autoinspector = new \Autoinspector\AutoinspectorClient('YOU_API_KEY_GOES_HERE');