Respuesta HTTP
Según el resultado de la llamada a la API será el código de estado HTTP que tendrá la respuesta:
El código de estado será 200 si no ocurrió ningún error.
El código de estado será 4xx si ocurrió algún error (por ejemplo, 400 Bad Request, 401 Unauthorized, 404 Not Found, etc).
El código de estado será 429 Too Many Requests cuando se envían más de 10 peticiones en un período límite de 5 segundos.
Formato de las respuestas
Todos los datos son devueltos en formato JSON.
Tipos de respuesta
Todas las respuestas están formadas por un objeto "result". Dentro de este objeto se incluyen los datos propios de la respuesta.
Peticiones que devuelven un único elemento
La respuesta está formada por un objeto "item" que contiene los datos del elemento buscado.
Por ejemplo, peticiones para obtener un producto, obtener una categoría, obtener una variante.
{
"result": {
"item": {
"codigo": "CAT-03",
"activo": "1",
"nombre_es": "Categoría 3",
"nombre_en": "",
"codigo_padre": "CAT-01"
}
}
}
Peticiones que devuelven uno o más elementos
La respuesta está formada por un objeto "items" que contiene una serie de objetos con los datos obtenidos y un valor "count" que indica la cantidad de objetos dentro de "items".
Por ejemplo, peticiones para obtener todos los productos, obtener las fotos de un producto, obtener los precios de un producto.
{
"result": {
"count": "3",
"items": [
{
"codigo": "CAT-01",
"activo": "1",
"nombre_es": "Categoría 1",
"nombre_en": "",
"codigo_padre": ""
},
{
"codigo": "CAT-02",
"activo": "0",
"nombre_es": "Categoría 2",
"nombre_en": "",
"codigo_padre": ""
},
{
"codigo": "CAT-03",
"activo": "1",
"nombre_es": "Categoría 3",
"nombre_en": "",
"codigo_padre": "CAT-01"
}
]
}
}
Peticiones que devuelven una cantidad numérica
La respuesta está formada por el valor "count" que indica la cantidad de registros hallados o afectados por una operación.
Por ejemplo, peticiones para obtener la cantidad de categorías, crear un producto, borrar una variante.
{
"result": {
"count": "3"
}
}
Peticiones que devuelven un error
Cuando una petición falla, la respuesta contendrá un objeto "error" con los siguientes valores:
http_status: código de estado HTTP con el que ha respondido la API.
message: texto informando el motivo del error.
code: un código que identifica al tipo de error.
info: información adicional.
Ejemplo:
{
"result": {
"error": {
"http_status": "400",
"message": "El valor (codigo) no es válido",
"code": "invalid_value",
"info": "El producto (PROD-00145) no existe"
}
}
}
