Proceso de integración
Toda integración con la API de YAPU sigue un proceso de entrega estructurado en tres fases. Esta página explica cada fase, quién es responsable de qué y qué esperar en cada paso.
Descripción general del proceso
Especificación → Desarrollo → Pruebas → Sistema listo
(1–3 semanas) (2–8 semanas) (1–2 semanas)
Los plazos son aproximados. La duración del desarrollo depende de la priorización interna de software de YAPU y de la rapidez con que tu equipo complete el desarrollo.
Fase 1 — Especificación
Duración: 1–3 semanas tras la firma del contrato
La fase de especificación establece una comprensión técnica compartida antes de que comience cualquier desarrollo. Ambas partes deben acordar el diseño de la integración antes de avanzar.
Pasos
| Paso | Responsable | Descripción |
|---|---|---|
| 1. Llamada de requisitos | Ambas partes | Llamada conjunta para identificar los requisitos de REST API y los objetivos de integración |
| 2. Creación del caso de uso | YAPU | YAPU crea el caso de uso de la API y el diagrama de flujo de datos/usuario |
| 3. Acuerdo sobre el caso de uso | Ambas partes | Ambas partes revisan y acuerdan el caso de uso y el flujo |
| 4. Especificación de datos | Guiado por YAPU | YAPU guía al cliente en la especificación de los datos exactos a transferir |
| 5. Documentación técnica | YAPU | YAPU elabora la documentación técnica completa de la API |
| 6. Acuerdo sobre la documentación | Ambas partes | Ambas partes revisan y aprueban la documentación técnica |
Entregables
- Caso de uso y diagrama de flujo acordados
- Documentación técnica de la API finalizada
- Campos y formatos de datos confirmados en ambas direcciones
Prepara a tu equipo de integración para la llamada de requisitos. Cuanto más claramente puedas describir tu flujo operativo y lo que necesita hacer tu sistema, más rápido avanzará la fase de especificación.
Fase 2 — Desarrollo
Duración: 2–8 semanas tras completarse la especificación
Tanto YAPU como el cliente desarrollan sus respectivos lados de la integración en paralelo, trabajando a partir de la documentación técnica acordada.
Desarrollo por parte de YAPU
El equipo de ingeniería de YAPU implementa los endpoints de la API y la lógica de integración en la plataforma de YAPU.
Desarrollo por parte del cliente
Tu equipo de desarrollo implementa la integración en el lado de tu sistema — realizando solicitudes a la API de YAPU y gestionando las respuestas según la especificación acordada.
Alineación
Si surgen dudas o discrepancias durante el desarrollo, se realizan llamadas de alineación entre YAPU y el equipo del cliente para resolverlas antes de las pruebas.
:::warning Nota sobre el plazo de desarrollo El rango de 2–8 semanas refleja la variabilidad en la cola de priorización interna de software de YAPU y la velocidad de desarrollo del cliente. Tu contacto en YAPU te mantendrá informado del calendario de desarrollo de YAPU. :::
Fase 3 — Pruebas
Duración: 1–2 semanas tras finalizar el desarrollo por ambas partes
Las pruebas confirman que la integración funciona de extremo a extremo antes de pasar a producción.
Pasos de las pruebas
| Paso | Entorno | Descripción |
|---|---|---|
| 1. Pruebas internas | Sistema propio de cada parte | Cada parte prueba su propia implementación de forma independiente |
| 2. Pruebas de integración conjuntas | Staging | Ambas partes prueban la integración completa en el entorno de staging |
| 3. Despliegue en producción | Producción | Ambas partes despliegan su integración en producción |
| 4. Pruebas de integración conjuntas | Producción | Ambas partes prueban la integración completa en producción para confirmar la preparación para la puesta en marcha |
Una vez que ambas partes confirman las pruebas en producción, el sistema está listo para usar.
Resumen de responsabilidades
| Responsabilidad | YAPU | Cliente |
|---|---|---|
| Crear el caso de uso y el diagrama de flujo | ✓ | |
| Guiar la especificación de datos | ✓ | |
| Crear la documentación técnica de la API | ✓ | |
| Desarrollar la API del lado de YAPU | ✓ | |
| Desarrollar la integración del lado del cliente | ✓ | |
| Pruebas internas del propio desarrollo | ✓ | ✓ |
| Pruebas de integración conjuntas en staging | ✓ | ✓ |
| Despliegue en producción | ✓ | ✓ |
| Pruebas de integración conjuntas en producción | ✓ | ✓ |
Estimación del plazo total
| Fase | Duración estimada |
|---|---|
| Especificación | 1–3 semanas |
| Desarrollo | 2–8 semanas |
| Pruebas | 1–2 semanas |
| Total | 4–13 semanas |
Después de la puesta en producción
Una vez que el sistema está en producción y ambas partes han confirmado que la integración funciona correctamente, comienza un período de estabilización. Durante este período, tu contacto en YAPU permanece disponible para dar soporte ante cualquier incidencia derivada del uso en producción.
Consulta Pruebas y puesta en producción para obtener detalles sobre el proceso de pruebas y la lista de verificación de puesta en marcha.