API Respuestas

Todas las respuestas tendrán una estructura común y unos parámetros específicos. El formato es el siguiente:

Body

• type (enum[string]): Tipo de respuesta:
  • success
  • warning
  • error
• code (string): Código identificador del resultado. Es un código orientativo y no está ligado estrictamente con motivo de la respuesta, es decir, el código no identifica inequívocamente la respuesta. Para más detalle visitar el siguiente enlace: Códigos de respuesta.
  • Code = 0 --> success
  • Code > 0 --> warning
  • Code < 0 --> error
• detail (string): Código alfanumérico separado con guiones bajos y sin mayúsculas que identifica inequívocamente la respuesta. Útil para la gestión de los diferentes casos de uso de una operación.
• description (string): Descripción literal del mensaje de respuesta.
• uuid (string): Identificador único de la petición, imprescindible para la trazabilidad.
• request_id (string): Necesario para la finalización de algunas operaciones. Se indicarán aquellas en las que sea necesario.
• payload (object): Parámetros de respuesta.

Headers

• Content-Signature: La firma del cuerpo de la respuesta con la clave secreta. HMAC(body, secret, mode).

Ejemplo

{
    "type": "success",
    "code": "0",
    "detail": "action_successful",
    "description": "Action successful",
    "uuid": "40f71c58-499d-404f-a3fe-6aa880a64176",
    "payload": {
        "param1": "value1",
        "param2": "value2"
    }
}