Las respuestas a las llamadas a la API de Toku utilizan la convención de códigos de estado HTTP para indicar si la llamada fue exitosa o fallida.
Status | Significado | Descripción |
---|---|---|
200 | OK | OK. La llamada fue exitosa. |
201 | Created | Creado. La llamada fue exitosa y un nuevo objeto o grupo de objetos fue creado. |
401 | Unauthorized | Falta de credenciales. No indicaste la API Key en el Header de la llamada, o lo hiciste con un formato incorrecto. |
403 | Forbidden | Falta de permisos. Según la API Key que indicaste en el Header, no tienes permisos para realizar este tipo de llamada. |
404 | Not Found | No encontrado. Según la API Key indicada en el Header, el recurso no existe. Esto también puede indicar que no tienes permitido realizar este tipo de llamada. |
422 | Unprocessable Entity | No procesable. La llamada está bien formada pero contiene errores semánticos. Tal ves te faltaron campos que son requeridos, o incluiste campos que no corresponden. |
429 | Too Many Requests | Demasiadas solicitudes. Llamaste muchas veces seguidas a la API, espera un poco. |
Los errores suelen incluir mas detalles al respecto en el body de la respuesta, en la propiedades code
y message
.
{
"error":{
"message":"error",
"code":"TKXXXX"
}
}
En particular, los errores 422: Unprocessable Entity
devuelven el detalle en la propiedad details
.
{
"error": {
"code": "TK30000",
"details": [
{
"loc": [
"body"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
}
Las respuestas ante llamadas exitosas varian según el endpoint. Las revisaremos en detalle a continuación.