Guías

Guías de implementación

Una guía de punta a punta por módulo del API Gateway, con flujos reales, estados, scopes, errores de negocio, datos de prueba del sandbox, webhooks y ejemplos en los cinco SDK y cURL.

Cada guía cubre un módulo completo: qué resuelve, los scopes que necesita tu llave, el flujo de negocio de principio a fin, los errores típicos del motor, cómo probarlo en el sandbox y qué eventos de webhook emite. Todos los ejemplos están en Python, JavaScript/TypeScript, PHP, .NET, Go y cURL; elige tu lenguaje una vez y se recuerda en todo el sitio.

¿Qué módulo integra tu entidad? #

Si eres…Empieza porY luego
Caja de compensación (como Caja Horizonte)AfiliadosSubsidios y cuota monetaria, Créditos, Cartera, PQRS
Cooperativa o fondoCréditosCartera, PQRS
Fintech o billetera (como Nova)BilleteraWebhooks, PQRS
IPS (como IPS Horizonte Salud)SaludWebhooks, PQRS
Cualquier entidad con su ERPAdministrativoTransacciones y sistema
flowchart LR
  subgraph Originación
    AF[Afiliados] --> CR[Créditos]
    AF --> SU[Subsidios y<br/>cuota monetaria]
  end
  CR -- desembolso --> CA[Cartera]
  CR -- desembolso --> BI[Billetera]
  SU -- pago --> BI
  BI --> PQ[PQRS]
  CA --> PQ
  SA[Salud] --> PQ
  AD[Administrativo] -.contabilidad.- CA
  BI -.eventos.-> WH((Webhooks))
  CR -.eventos.-> WH
  CA -.eventos.-> WH
  SA -.eventos.-> WH

Antes de empezar cualquier guía #

  1. Ten tu llave de sandbox con los scopes del módulo.
  2. Lee Idempotencia y Errores: todas las guías asumen que reintentas con la misma Idempotency-Key y que distingues los rechazos del motor.
  3. Si el módulo mueve dinero o cambia estados de forma asíncrona, configura antes tu receptor de webhooks.

Para ver todas las operaciones de un módulo con sus parámetros exactos, ve a la referencia del API. Para flujos que cruzan módulos, mira las recetas.

En esta sección #

Guía de implementación AfiliadosCruza y registra la base de afiliados por lotes JSON o por archivo CSV/Excel, consulta un afiliado por documento y recibe el evento affiliates.synced. Con normalización … Guía de implementación CréditosOriginación de crédito de punta a punta: radicar la solicitud, trabajar la bandeja, decidir (APPROVE/REJECT), desembolsar, seguir los estados y recibir los eventos … Guía de implementación Subsidios y cuota monetariaRadica subsidios de ley por tipo (p. ej. unemployment), trabaja la bandeja y decide; genera la cuota monetaria del período con dry_run, lístala y desembolsa cada una. Con … Guía de implementación BilleteraOpera la billetera de tus afiliados server-to-server: saldo y movimientos, transferencias P2P y Bre-B, pago de facturas, recargas, bolsillos, tarjetas y cambio de … Guía de implementación CarteraLa vida del crédito desembolsado por API: préstamos del afiliado, plan de cuotas y desglose por prelación, historial de pagos, registro de recaudos con referencia única … Guía de implementación PQRSRadica, consulta, responde y gestiona las peticiones, quejas, reclamos y sugerencias de tus afiliados desde tu CRM o call center, con plazos de ley, historial auditado y … Guía de implementación Salud (IPS)Para IPS: catálogo y disponibilidad, agendar, cancelar, reprogramar y registrar asistencia en nombre del paciente; facturas de salud con estado DIAN, XML, RIPS y glosas; … Guía de implementación Administrativo (ERP)Integra tu ERP con Gestión Administrativa: colaboradores, contratos y novedades de talento humano, novedades y desprendibles de nómina, comprobantes contables en … Guía de implementación Transacciones y sistemaConsulta el estado asíncrono de cualquier escritura con client.transactions.get (status, history, reference) y valida la llave y sus scopes con client.system.health, …