HTTP status code se utiliza para indicar el éxito o el error de una llamada a la API. El cuerpo de la respuesta contiene los detalles del error en formato JSON.

HTTP CODE STATUSDescripción
200 - OKTodo funcionó como se esperaba.
400 - Bad RequestLa solicitud es inaceptable, a menudo debido a que falta un parámetro obligatorio.
401 - UnauthorizedNo se proporcionó una clave de API válida o no tiene permisos para usar la organización.
403 - ForbiddenNo se proporcionó ninguna clave de API.
404 - Not FoundEl recurso de API no existe.
500 - Server ErrorLa llamada a la API fue válida pero falló debido a errores en el lado del servidor de Axteroid.

Ejemplo de respuesta de error:

A continuación se muestra el error que se devuelve para la llamada a la API "Crear un documento" el tipo de valor de un atributo no corresponde en tipo. El código de estado HTTP devuelto será 400.

{
  "customer": [
    "tax_id": "A data with a maximum of 32 characters was expected."
  ]
}

Cuando se trata de errores en los campos enviados, la plantilla de error obedece al campo: [errors_list], mientras que si se trata de errores generales, la plantilla de errores obedece a non_errors_key: [errors_list]

{
  "field_1": [
      "error 1",
      "error 2",
      ...
  ],
  "non_field_errors": [
      "error 1",
      "error 2",
      ...
  ],
  "field_2": [
    {
      "sub_field_1": [
        {
          "sub_sub_field_1": [
            "This field is required."
          ]
        }
      ]
    }
  ]
}