Por medio de nuestra API, serás notificado con toda la información en caso presentes un error al momento de hacer una petición.
Utilizamos el estándar de Códigos de Estado HTTP (HTTP Status Codes) en todas sus respuestas para indicar si las solicitudes se pudieron procesar con éxito o fallaron.
Códigos HTTP
| Código |
HTTP Status |
Descripción |
| 200 |
OK |
Todo salió a la perfección. |
| 201 |
Created |
Un nuevo recurso fue creado. (POST). |
| 204 |
No Content |
El recurso fue exitosamente eliminado. (DELETE) |
| 400 |
Bad Request |
La petición al servidor no pudo ser procesada debido a una sintáxis incorrecta. |
| 401 |
Unauthorized |
El recurso solicitado no está autorizado. |
| 404 |
Not Found |
El recurso solicitado en la llamada no existe. |
| 500 y 503 |
Server Errors |
Error en nuestro servidor, la petición no pudo ser procesada. |
Tipos de errores
Devolvemos los siguientes tipos de errores relacionados con los códigos de estado HTTP en las respuestas:
| Type |
HTTP Status Code - Descripción |
| ZL-400 |
HTTP 400 - No se puede asignar los puntos. Data está incompleta. |
| ZL-401-10 |
HTTP 401 - Clave utilizada es inválida. |
| ZL-401-05 |
HTTP 401 - Empresa debe validar activación de su cuenta. |
| ZL-404-10 |
HTTP 404 - Usuario no identificado. |
| ZL-404-05 |
HTTP 404 - Empresa no identificada. |
| ZL-503 |
HTTP 500 y 503 - Engloba cualquier otro tipo de error con el servidor. |
Casos de Errores
A continuación te presentamos una serie de ejemplos de errores comunes a la hora de integrar nuestra API.
Petición inválida
El formato de la petición contine información errada, incompleta.
{
"codigo": "ZL-400",
"mensaje": "No se puede asignar los puntos. Data está incompleta.",
"titular": "",
"importe_compra": "0",
"puntos_acumulados": "0",
"puntos_compra": "0",
"fecha_proceso": "Y-m-d H:i:s"
}
Autenticación
No ingresaste una Clave de autorización válida.
{
"codigo": "ZL-401-10",
"mensaje": "Clave utilizada es inválida.",
"titular": "",
"importe_compra": "0",
"puntos_acumulados": "0",
"puntos_compra": "0",
"fecha_proceso": "Y-m-d H:i:s"
}
Activación
Empresa debe validar si su cuenta está activa.
{
"codigo": "ZL-401-05",
"mensaje": "Empresa debe validar activación de su cuenta.",
"titular": "",
"importe_compra": "0",
"puntos_acumulados": "0",
"puntos_compra": "0",
"fecha_proceso": "Y-m-d H:i:s"
}
Usuario no identificado
No ingresaste un Id de Usuario válido.
{
"codigo": "ZL-404-10",
"mensaje": "Usuario no identificado.",
"titular": "",
"importe_compra": "0",
"puntos_acumulados": "0",
"puntos_compra": "0",
"fecha_proceso": "Y-m-d H:i:s"
}
Empresa no identificada
No ingresaste un Id de Empresa válido.
{
"codigo": "ZL-404-05",
"mensaje": Empresa no identificada.",
"titular": "",
"importe_compra": "0",
"puntos_acumulados": "0",
"puntos_compra": "0",
"fecha_proceso": "Y-m-d H:i:s"
}
Servicio no disponible
Se presentó algún inconveniente que no permitó concluir la asignación de puntos.
{
"codigo": "ZL-503",
"mensaje": "Mensaje del inconveniente presentado.",
"titular": "",
"importe_compra": "0",
"puntos_acumulados": "0",
"puntos_compra": "0",
"fecha_proceso": "Y-m-d H:i:s"
}
Manejo de errores
Nuestras bibliotecas manejan excepciones por muchas razones. Entre ellas tenemos parámetros inválidos, errores de autenticación, etc. Recomendamos que, contemples todos los escenarios y manejes todas las excepciones que presenta nuestra API.
Cuando se presente estos casos que impidió que al cliente se le asigne sus puntos, deberá asignarse los puntos a travès de la plataforma de Zoomlike.
Zoomlike