Saltar al contenido principal

Errores

Soyio usa códigos de respuesta HTTP estándar para indicar el resultado de cada petición:

  • 2XX: Éxito (ejemplo: 200 OK para una petición exitosa)
  • 4XX: Error del cliente (ejemplo: 400 Bad Request para parámetros inválidos)
  • 5XX: Error del servidor (ejemplo: 500 Internal Server Error)
info

Los mensajes de error usan un Content-Type de application/problem+json.

Errores Generales​

El formato general del payload de error es el siguiente:

    type string

    El tipo de error.

    Valores posibles: [api_error, authentication_error, invalid_request_error, rate_limit_error]

    title string

    Resumen corto y legible del tipo de problema

    status integer

    El código de estado HTTP generado por el servidor para esta ocurrencia del problema. Revisa los códigos de error HTTP.

    detail integer

    Una explicación breve, legible y específica para esta ocurrencia del problema.

Ejemplo​

{
  "type": "authentication_error",
  "title": "Authentication failed",
  "status": 401,
  "detail": "Invalid API key"
}

Errores de validación​

Corresponden a errores de validación (422) de los datos enviados en la request. Estos errores a diferencia de los generales, poseen un atributo errors que contiene la lista de errores asociados para contextualizar de mejor manera lo que necesita ser corregido. Estos siguen el siguiente formato:

    type string

    El tipo de error.

    Valores posibles: [validation_error]

    title string

    Resumen corto y legible del tipo de problema

    status integer

    El código de estado HTTP generado por el servidor para esta ocurrencia del problema. Revisa los códigos de error HTTP.

    errors string[]

    Una lista legible de errores de validación específicos.

Ejemplo​

{
  "type": "validation_error",
  "title": "Validation error",
  "status": 422,
  "errors": [
    "amount must be greater than 0",
    "name is required"
  ]
}

Códigos de error HTTP​

A continuación se describen los códigos de error HTTP que puedes recibir.

ErrorDescripción
400
Bad Request		Hay un problema con tu request 🙈
401
Unauthorized		Tu api key es incorrecta 🔐
403
Forbidden		No tienes permiso para ver esta página 🚫
404
Not Found		El recurso especificado no fue encontrado 😔
405
Method Not Allowed		Trataste de ingresar a un recurso con un método inválido
406
Not Acceptable		Solicitaste un formato que no es json 😣
410
Gone		El recurso solicitado fue removido de nuestros servidores 🏃
418Soy una tetera 😗☕️
422
Unprocessable Entity		No podemos procesar tu solicitud, revísala. 👀️
429
Too Many Requests		Estas solicitando muchos recursos! Detente! ✋
500
Internal Server Error		Tuvimos un problema con nuestro servidor. 😰 Inténtalo nuevamente mas tarde (estos son raros)
503
Service Unavailable		Estamos offline por mantenimiento. Inténtalo nuevamente mas tarde ‍👷🛠