URL, Ambiente y Respuesta en la API

Para interactuar con la API de nuestra plataforma, es esencial comprender cómo se estructuran las URLs de los endpoints y cómo funcionan los ambientes en los que se realizan las solicitudes. Cada llamada a la API se dirige a una URL que se compone de tres partes principales:

1. El Ambiente: El entorno al que estás apuntando con tu solicitud (pruebas o producción).
2. El Prefijo: V2/corporate-api-partner, que se utiliza para identificar las rutas específicas de los API partners.
3. El Recurso de la API: El endpoint específico al que deseas acceder.

Estructura General de la URL

La estructura general de una URL para hacer solicitudes a la API sigue el siguiente formato:

Ambiente/V2/corporate-api-partner${recurso_de_la_api}

Ambientes Disponibles

Ambiente	URL	Descripción
Beta	https://beta-new.ridery.app	Ambiente para realizar pruebas de desarrollo.
Staging	https://staging.ridery.app	Ambiente para realizar pruebas de QA e Integración.
Producción	https://corporativo-api.ridery.app	Ambiente utilizado para producción, accesible a usuarios finales.

Es fundamental asegurarse de construir correctamente estas URLs para cada solicitud, utilizando el ambiente apropiado y el recurso específico que se necesita acceder, para garantizar la efectividad de las interacciones con la API.

Respuesta

TODAS las respuestas de la API van a poseer un atributo/llave de nombre success. Este atributo es un booleano que indica si la respuesta fue correcta o incorrecta de la petición

Ejemplo de respuesta correcta (código de estado 200):

{
  "success": true,
  "data": {
    // La data servida por el endpoint
  }
}

Código 200: Indica una petición recibida y procesada correctamente por el servidor.

Ejemplo de respuesta incorrecta (código de estado 4xx o 5xx):

{
  "success": false,
  "error": {
    // La descripción del error
  }
}

Código 4xx: Indica un error del cliente, como solicitudes malformadas o falta de parámetros. Código 5xx: Indica un error del servidor, que puede ser temporal o debido a un mal funcionamiento interno.