Referencia de la API

URL

En la documentación, el endpoint de cada API se indicará con el path relativo respecto a la url de la API general:

https://api.auravant.com/api 

Autenticación

Es necesario autenticar una consulta a cualquiera de nuestras APIs incluyendo el header de autorización con el token en la request:

Authorization: Bearer <token>

El token es una variable global dentro de la Extensión, y es la credencial que se utilizará para identificarse ante nuestros servidores

Token de prueba

Para poder realizar pruebas, por ejemplo utilizando Postman, es posible generar un token de autenticación de prueba.

Para ello, es necesario tener autorizada la Versión de Desarrollo de la Extensión, y obtener el mismo desde el cuadro de la Versión en el espacio del Desarrollador.

Recuerda que este Token es sólo de prueba y NO debes incluirlo en el código de la Extensión, ya que éstos expiran y se generan dinámicamente cada vez que se ejecuta una Extensión.

Requests y Respuestas

Nuestras APIs reciben contenido tipo application/json o application/x-www-form-urlencoded

En la documentación de cada API, verás aclarado el Content-Type header que debes incluir en la llamada.

El contenido de la respuesta, en cambio, es siempre application/json, a excepción de las APIs que se utilizan para descargar contenido, como imágenes. En este último caso, el tipo de contenido de respuesta se indica en la Referencia.

Códigos de respuesta

Todas nuestras APIs incluyen en el JSON de respuesta, la propiedad code cuyo valor es un entero e indica el resultado de la consulta.

Cuando la operación de la API es exitosa (el status HTTP 200), code=0.

Cada API tiene códigos de error específicos, los cuales se indican en la Referencia de cada una.

Todas las APIs comparten ciertos códigos de error:

code	descripción
-1	Error general. Revisar correctamente los datos envíados y si el problema persiste, contactar a hola@auravant.com.
-2	El token utilizado para autenticarse se encuentra expirado.
-3	El token utilizado para autenticarse es inválido.
-4	Este error se debe a formatos de datos incorrectos. Revisar correctamente los datos envíados y si el problema persiste, contactar a hola@auravant.com
-5	Usualmente se da en las APIs que consumen datos. Este código indica que alguno de los datos enviados no tiene el formato o nombre correcto, o bien faltan datos. Se incluye la propiedad msg en la respuesta con información legible sobre el dato que produce el error.
-6	Error de integridad de datos
-7	Error de integridad de datos