Descripción general de los paquetes de API
YAPU ofrece un catálogo de paquetes de API estándar — casos de uso de integración predefinidos que combinan una o más llamadas a la API para cubrir un flujo de trabajo completo de extremo a extremo. Cada paquete está diseñado en torno a una necesidad de negocio específica y viene con actores, flujos de datos y responsabilidades claramente definidos.
¿Qué es un paquete de API?
Un paquete de API es un caso de uso de integración empaquetado. En lugar de construir una integración personalizada desde cero, los clientes seleccionan el paquete que se ajusta a su necesidad operativa y siguen un proceso estructurado de especificación y entrega.
Cada paquete incluye:
- Un caso de uso y propósito de negocio definidos
- Los actores involucrados (sistema del cliente, oficial de crédito, plataforma YAPU)
- El evento desencadenante que inicia la llamada a la API
- Los datos intercambiados en cada dirección
- Responsabilidades claras del cliente y de YAPU
- Requisitos técnicos y plazo de entrega
Independiente vs. no independiente
| Tipo | Descripción | Ejemplo |
|---|---|---|
| API independiente | Puede invocarse de forma autónoma, sin dependencia de otras APIs o del estado de la plataforma YAPU | YAPU SNAP |
| Paquete de API no independiente | Depende del contexto de la plataforma YAPU (p. ej., ya debe existir un cuestionario o un registro de cliente) | Paquetes de API estándar |
Todos los paquetes listados en esta página son no independientes. Operan dentro del ecosistema de la plataforma YAPU. Para la opción independiente, consulte YAPU SNAP.
Cómo elegir el paquete adecuado
Utilice estas preguntas para identificar el paquete que se ajusta a su caso de uso:
- ¿Qué desencadena la integración? ¿Es una acción del usuario (p. ej., enviar un formulario), un evento programado o un cambio de estado?
- ¿Qué datos deben moverse? ¿Su sistema envía datos a YAPU, los recibe desde YAPU o ambas cosas?
- ¿Cuál es el resultado de negocio esperado? ¿Qué debe ocurrir en su sistema como resultado de la integración?
Lleve sus respuestas a la llamada de especificación con su contacto en YAPU — en ese momento se confirma el paquete correcto (o la combinación de paquetes).
Catálogo de paquetes de API estándar
La tabla a continuación muestra los once paquetes estándar y cómo se diferencian en tres dimensiones: eventos desencadenantes, prellenado automático y verificación de elegibilidad. Úsela para identificar rápidamente qué paquete se ajusta a su caso de uso.
| Paquete | Desencadenador: Envío | Desencadenador: Actualización | Desencadenador: Aprobación | Prellenado automático | Verificación de elegibilidad |
|---|---|---|---|---|---|
| Bundle 1 | ✓ | ||||
| Bundle 2 | ✓ | ✓ | |||
| Bundle 3 | ✓ | ✓ | |||
| Bundle 4 | ✓ | ✓ | |||
| Bundle 5 | ✓ | ✓ | ✓ | ||
| Bundle 6 | ✓ | ✓ | ✓ | ||
| Bundle 7 | ✓ | ✓ | |||
| Bundle 8 | ✓ | ✓ | ✓ | ||
| Bundle 9 | ✓ | ✓ | ✓ | ||
| Bundle 10 | ✓ | ✓ | ✓ | ✓ | |
| Bundle 11 | ✓ | ✓ | ✓ | ✓ |
Descripción de los eventos desencadenantes:
- Envío — se activa cuando el oficial de crédito presiona Enviar en un cuestionario completado
- Actualización — se activa cuando se modifica un cuestionario o Credit Committee Report existente
- Aprobación — se activa cuando un usuario de YAPU establece el estado del informe en "Aprobación"
Descripción de las funciones de entrada:
- Prellenado automático — YAPU envía el ID del cliente a su sistema y recibe de vuelta los datos del perfil para preagregarlos en el cuestionario
- Verificación de elegibilidad — YAPU consulta su sistema para confirmar si el cliente es elegible antes de que el cuestionario continúe; los clientes no elegibles son detenidos de inmediato
Próximos pasos
- YAPU SNAP — si necesita la API de riesgo climático independiente
- Primeros pasos — inicie el proceso de incorporación de la integración
- Proceso de integración — comprenda los plazos y las responsabilidades
- Soporte y contacto — comuníquese con su representante de YAPU