Title
Create new category
Edit page index title
Edit category
Edit link
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:
Sandbox: https://api.paas.sandbox.co.passportfintech.com
Production: https://api.paas.co.passportfintech.com
Ejemplo
Asegú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:
Versión Estable Actual
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:
Ejemplo
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, |
{resource} | Recurso principal al que estás accediendo (por ejemplo, |
{identifier} | ID único, si aplica (por ejemplo, en un |
Peticiones DELETE devuelven el código HTTP 204 Content Not Found, sin cuerpo de respuesta.
Códigos HTTP
Método | Descripción |
|---|---|
GET | Se utiliza para recuperar un recurso específico o una colección de recursos del servidor, permitiendo que los clientes accedan y usen los datos de forma eficiente. |
POST | Permite crear un recurso o enviar una acción específica dentro de la plataforma. |
PATCH | Permite modificar únicamente los campos que deben cambiarse sin alterar el recurso completo. Asegúrate de que el cuerpo incluya solo los campos que deseas actualizar en el formato adecuado. |
DELETE | Elimina o revoca permisos o acceso para un usuario o recurso específico. |
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
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
Parámetros de consulta (Query Parameters)
Los métodos GET aceptan parámetros de consulta. Para más detalles, se recomienda revisar la página específica de cada objeto. Puedes encontrar esta información en las páginas que llevan el nombre "Listar" seguido del nombre del objeto, como por ejemplo: "Listar Pagos".