Estructura de Endpoints
Introducción
Comprender la estructura de los endpoints de la API de Passport es clave para lograr una integración fluida. En esta sección te explicamos la URL base, el sistema de versionado y las mejores prácticas para construir tus solicitudes API.
URL Base
Todas las solicitudes a la plataforma Passport deben enviarse a la siguiente URL base:
https://bre-b-sandbox.api.visionamos.passportfintech.comAsegúrate siempre de utilizar HTTPS para garantizar la seguridad en la transmisión de datos.
Versionado de la API
La API de Passport utiliza un sistema de versionado para mantener la compatibilidad hacia atrás. La versión se incluye como parte de la ruta del endpoint:
https://bre-b-sandbox.api.visionamos.passportfintech.com/{version}/Versión Estable Actual
https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/Consejo: Revisa siempre en esta documentación cuál es la versión más reciente de la API para aprovechar mejoras y actualizaciones.
Formato de los Endpoints
Cada endpoint sigue una estructura definida:
{base_url}/{version}/{resource}/{identifier}Desglose del Ejemplo
| Segmento | Descripción |
|---|---|
| {base_url} | Dominio raíz donde se envían las solicitudes. |
| {version} | Versión de la API (por ejemplo, v1). |
| {resource} | Recurso principal al que estás accediendo (por ejemplo, iam/oauth/tokens). |
| {identifier} | ID único, si aplica (por ejemplo, en un GET a iam/oauth/tokens/{token_id}). |
Estructura de Solicitud y Respuesta
Formato de Solicitud
Todas las solicitudes deben enviarse en formato JSON e incluir los headers de autenticación necesarios.
Ejemplo de Solicitud
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts' \--header 'Content-Type: application/json' \--header 'Authorization: ••••••' \--data '{ "entity_customer_id": "d490794d-183f-4226-80a7-e75edce0e4fe", "type": "ORDINARY"}'Formato de la Respuesta
Las respuestas de la API están estructuradas en JSON y te ofrecen una vista clara y detallada del objeto retornado.
Ejemplo de la Respuesta
{ "available_balance": { "currency": "COP", "value": "0" }, "pending_balance": { "currency": "COP", "value": "0" }, "type": "ORDINARY", "entity_customer_id": "d490794d-183f-4226-80a7-e75edce0e4fe", "number": "880368444", "id": "ca3fe9c0-7ddd-455d-92c1-4c749d22c0ee"}