API Reference
Todo lo que necesitas saber para integrarte vía API
Visión general de la API
La API de VAIS te permite interactuar de forma directa con toda la información que necesitas para desarrollar tus integraciones como desees. Nuestras APIs son del tipo REST y tienen URLs autoexplicativas. Aceptan cuerpos en las solicitudes y devuelven respuestas codificadas en JSON. Usan los códigos de respuesta, autenticación y métodos de solicitud del estándar HTTP.
URL Base
En VAIS te ofrecemos dos entornos:
-
Producción: es el entorno con impacto real para el negocio.
https://api.vaistech.io -
Staging: es el entorno en el que podés simular el uso de
nuestros productos.
https://api-staging.vaistech.io
Autenticación
Realizá todas las solicitudes a nuestra API utilizando HTTPS e incluyendo las credenciales de tu aplicación para autenticar cada interacción. Las llamadas realizadas sin autenticación fallarán.
Authorization: Bearer YOUR_API_KEY Formato de las respuestas
Todas las respuestas están codificadas en JSON y siguen la siguiente estructura:
{
"status": "success",
"data": { },
"meta": { }
} Límites de uso
Nuestra API implementa límites de uso para garantizar la estabilidad y un uso equitativo:
- 100 solicitudes por minuto por clave API
- 1000 solicitudes por hora por clave API
- 10000 solicitudes por día por clave API
La información sobre los límites está incluida en los encabezados de las respuestas:
X-RateLimit-Limit: 100 X-RateLimit-Remaining: 95 X-RateLimit-Reset: 1625097600
Manejo de errores
La API utiliza códigos de respuesta HTTP convencionales para indicar el éxito o fallo de una solicitud:
- 2xx
Éxito – la solicitud fue procesada correctamente.
- 4xx
Error del cliente – hubo un problema con la solicitud.
- 5xx
Error del servidor – ocurrió un problema de nuestro lado.
Formato de respuesta ante errores:
{
"status": "error",
"error": {
"code": "invalid_request",
"message": "La solicitud es inválida",
"details": { }
}
}