Control de errores

Última actualización: 16 de julio de 2024
  • Temas:

Creado para:

  • Desarrollador

Cuando se produce un problema al realizar una llamada a la API de Reactor, puede dar error de una de las siguientes maneras:

  • Errores inmediatos: Al realizar una solicitud que resulta en un error inmediato, la API devuelve una respuesta de error, con el estado HTTP reflejando el tipo general de error que se produjo.
  • Errores retrasados: Al realizar una solicitud de API que resulta en un error retrasado (como una actividad asincrónica), la API puede devolver un error en el caso meta.status_details de un recurso relacionado.

Formato de error

Las respuestas de error pretenden ajustarse a la especificación de errores JSON:API y, en general, adherirse a la siguiente estructura:

{
  "errors": [
    {
      "id": "8a5526da-ab12-4be9-b084-2efe537f388c",
      "status": "404",
      "code": "not-found",
      "title": "Record Not Found",
      "meta": {
        "request_id": "jfb0dQ2e0XVTkQ6AOfEJFfTDjguw9x3d"
      },
      "source": {
        "pointer": "/data"
      }
    }
  ]
}
PropiedadDescripción
idUn identificador único para esta incidencia particular del problema.
statusEl código de estado HTTP aplicable a este problema, expresado como un valor de cadena.
codeUn código de error específico de la aplicación, expresado como valor de cadena.
titleUn breve resumen legible en lenguaje natural del problema que no debería cambiar de ocurrencia a ocurrencia, excepto para fines de localización.
detailUna explicación legible en lenguaje natural específica de esta ocurrencia del problema. Al igual que title, el valor de este campo se puede localizar.
source

Un objeto que contiene referencias al origen del error, incluyendo opcionalmente cualquiera de los siguientes miembros:

  • pointer: una cadena de puntero JSON (RFC6901) que hace referencia a la entidad asociada en el documento de solicitud (por ejemplo, /data para un objeto de datos principal o /data/attributes/title para un atributo específico).
metaUn objeto que contiene metadatos no estándar sobre el error.