Desarrolladores
Contratos públicos, ejemplos de integración y criterios para conectar White Label con las herramientas de tu equipo.
HTTP · Entrada pública
GET /api/v1/platform/config
Accept: application/json
Marca · Países · Sedes · MódulosUna entrada común
El gateway público reúne los contratos que consume una implementación conectada. Su origen se entrega para cada entorno.
Consulta primero la configuración pública y utiliza sus países, idiomas y sedes habilitados para construir el contexto. Todas las rutas de esta referencia parten del prefijo /api/v1.
JavaScript · Consulta de configuración
const apiBase = "https://api.example.com/api/v1";
const response = await fetch(apiBase + "/platform/config");
if (!response.ok) {
throw new Error("No fue posible consultar la configuración");
}
const configuration = await response.json();
console.log(configuration.companyName);Ejemplos de contrato
Reemplaza api.example.com por el origen de tu entorno. Los identificadores y cuerpos de ejemplo son ficticios; el acceso real depende de la configuración, los módulos y la validación de tu implementación.
Configuración y contenido publicados, tasas por sede y cotización según capacidad. Utiliza los identificadores del entorno; la empresa se resuelve en el servidor.
En web, la sesión usa una cookie HttpOnly. En móvil, los contratos de cliente admiten su bearer. Cada cliente consulta y gestiona sus propias solicitudes.
La sesión del personal administrativo es independiente. El frontend web puede mediar las llamadas del cliente mediante sus propias rutas de servidor; esas rutas no son el catálogo del gateway.
Identidad y permisos
La identidad procede de la sesión. El servidor valida plan, módulo, rol y sede; enviar un identificador desde la interfaz no concede acceso. Las credenciales internas y de proveedores se mantienen en el servidor.
Contrato público
Busca por ruta, método o función. Los cuerpos muestran la estructura admitida; las respuestas y validaciones completas se concretan para el entorno de entrega.
8 contratos en esta referencia
/api/v1/platform/configConsulta la marca, el modelo visual, los países, las sedes y los módulos publicados para la implementación.
/api/v1/platform/content/{country}/{locale}Obtén el contenido publicado para un país y un idioma configurados.
/api/v1/market/branches/{branchId}/rates/{currency}Consulta la tasa efectiva para una moneda dentro de una sede habilitada.
/api/v1/market/quotesSolicita al servidor una cotización para una sede, dos monedas y un importe.
JSON · Cuerpo de crear una cotización
{
"branchId": "branch-example",
"from": "USD",
"to": "COP",
"amount": "100.00"
}/api/v1/customer/auth/sessionComprueba si existe una sesión válida y recupera el contexto del cliente autenticado.
/api/v1/customer/pre-operationsCrea una solicitud propia a partir de una cotización vigente.
JSON · Cuerpo de solicitar atención
{
"quoteId": "11111111-1111-4111-8111-111111111111"
}/api/v1/customer/pre-operations?page=1Recupera las solicitudes del cliente autenticado, con paginación de 25 elementos.
/api/v1/customer/pre-operations/{id}/cancelSolicita la cancelación con control de versión y un motivo.
JSON · Cuerpo de cancelar una solicitud
{
"expectedVersion": 1,
"reason": "No podré asistir a la sede."
}400
Comprueba códigos, identificadores y el formato de los importes.
401
Solicita acceso de nuevo antes de consultar datos privados.
403
Revisa plan, módulo, rol y sede con la persona responsable.
404
La sede o solicitud puede no estar disponible dentro de tu contexto.
409
Puede existir un conflicto de versión, vencimiento o un reintento con datos distintos.
429
Respeta el límite de solicitudes y evita envíos repetidos.
5xx
Una respuesta incierta no demuestra que una escritura haya fallado.
Importes, versiones e idempotencia
Los importes financieros viajan como cadenas decimales. En una escritura, conserva cuerpo y clave de idempotencia cuando el contrato la requiere. Un conflicto de versión exige consultar el estado actual; un timeout exige comprobar qué ocurrió antes de iniciar otra acción.
Qué sistema origina el dato, quién lo necesita y qué acción debe producir.
Módulos, proveedor externo, permisos y separación entre entornos de prueba y operación.
Casos válidos, errores, vencimientos, conflictos y reintentos antes de la entrega.
Acordemos el flujo, los contratos y las validaciones de tu integración.