Saltar al contenido principal

Introducción

Información general​

Para utilizar la API, todas las solicitudes deben enviarse a la siguiente URL base:

API
https://api.meridianosoft.com.ar/api/v1

Autenticación​

La API utiliza autenticación de tipo Bearer. Cada solicitud debe incluir un token en el encabezado para validar el acceso:

Encabezado
Authorization: Bearer {token}

Formato de respuesta​

Las respuestas de la API se devuelven en formato JSON e incluyen un campo success para indicar si la solicitud fue exitosa. En caso de error, se proporcionan campos adicionales como error, status, message y request_uuid para facilitar el diagnóstico.

Manejo de errores​

Códigos de estado HTTP​

La API utiliza códigos de estado HTTP estándar para indicar el resultado de cada solicitud:

  • HTTP 2XX: Solicitud exitosa.
  • HTTP 4XX: Error en la solicitud (cliente).
    • HTTP 400: Solicitud inválida.
    • HTTP 401: Token expirado.
    • HTTP 429: Límite de llamadas excedido.
  • HTTP 5XX: Error en el servidor.
    • HTTP 500: Error interno del servidor.
    • HTTP 503: Servidor en mantenimiento.

Estructura de la respuesta ante errores​

Cuando el servidor responde con un estado de error, el cuerpo de la respuesta incluye los siguientes detalles:

  • success: Indica si la solicitud se procesó correctamente.
  • error: Código que identifica el tipo de error.
  • request_uuid: Identificador único (UUID) de la solicitud.
  • status: Código de estado HTTP devuelto por el servidor.
  • message: Descripción del error ocurrido.

Valores posibles para error:

  • missing-token: Token faltante (HTTP 400).
  • invalid-token: Token inválido (HTTP 400).
  • expired-token: Token expirado (HTTP 401).
  • invalid-request: Solicitud inválida (HTTP 400).
  • too-many-requests: Límite de llamadas excedido (HTTP 429).
  • server-error: Error en el servidor (HTTP 500).
  • under-maintenance: Servidor en mantenimiento (HTTP 503).
Mensaje de error (ejemplo)
{
  "success": false,
  "error": "invalid-request",
  "request_uuid": "c822cdfe-4bf5-4643-904c-5bbbcd71bc85",
  "status": 400,
  "message": "La solicitud no es válida"
}