Saltar al contenido principal

Primeros pasos

Esta guía te orienta en los primeros pasos de una integración con la API de YAPU — desde la comprensión de los requisitos previos hasta el conocimiento de cómo es el proceso de incorporación.

Requisitos previos​

Antes de comenzar una integración con la API de YAPU, asegúrate de que se cumplan los siguientes puntos:

RequisitoDescripción
Contrato firmadoUna integración con la API de YAPU requiere un contrato activo. El proceso de entrega comienza tras la firma.
Contacto de YAPU asignadoTrabajarás con un representante del equipo de Customer Success o Digitalización de YAPU durante todo el proceso.
Equipo técnico disponibleTu organización necesita un equipo de desarrollo capaz de implementar una conexión REST API sobre HTTPS.
Capacidad para JSONTodas las solicitudes y respuestas de la API de YAPU utilizan JSON. Tus sistemas deben poder enviar y parsear JSON.
Soporte para HTTPSToda la comunicación con las APIs de YAPU debe realizarse sobre HTTPS. HTTP no es compatible.
Soporte para IP dinámicaYAPU opera con comunicación por IP dinámica. La comunicación por IP estática no es compatible.

Descripción general del proceso de incorporación​

Una integración con la API de YAPU sigue tres fases estructuradas. Tu contacto en YAPU te guiará a través de cada una de ellas.

Fase 1 — Especificación (1–3 semanas)​

Durante la especificación, YAPU y tu equipo se alinean en los requisitos de la integración:

  1. Se realiza una llamada conjunta para identificar los requisitos de tu REST API.
  2. YAPU crea el caso de uso de la API y el diagrama de flujo de datos/usuario.
  3. Ambas partes revisan y acuerdan el caso de uso y el flujo.
  4. YAPU guía a tu equipo en la especificación de los datos requeridos para la transferencia.
  5. YAPU elabora la documentación técnica de la API.
  6. Ambas partes acuerdan la documentación técnica final antes de que comience el desarrollo.

Fase 2 — Desarrollo (2–8 semanas)​

Tanto YAPU como tu equipo desarrollan sus respectivos lados de la integración en paralelo. Se realizan llamadas de alineación si se necesita aclaración. El plazo depende de la priorización interna de software de YAPU y de la rapidez con que tu equipo complete el desarrollo.

Fase 3 — Pruebas (1–2 semanas)​

Las pruebas se realizan en dos etapas:

  1. Cada parte prueba su propia implementación de forma independiente.
  2. Se realizan pruebas de integración conjuntas en el entorno de staging.
  3. Ambas partes despliegan en producción.
  4. Se realizan pruebas de integración conjuntas en el entorno de producción.

Una vez completadas las pruebas en producción, el sistema está listo para usar.

Qué esperar​

  • Plazos: Una integración típica tarda entre 4 y 13 semanas desde la firma del contrato, según la complejidad, la priorización y la velocidad de desarrollo del cliente.
  • Soporte: Tu contacto en YAPU está disponible durante todas las fases para responder preguntas y resolver bloqueos.
  • Documentación: YAPU proporciona la documentación técnica de la API como parte de la fase de especificación. Este portal sirve como referencia complementaria.

Próximos pasos​

Una vez que tu contrato esté en vigor y tu contacto en YAPU haya sido asignado, el primer paso es la llamada de especificación. Mientras tanto, explora las siguientes secciones para preparar a tu equipo:

tip

Usa las páginas de descripción general de los bundles de API y Proceso de integración para preparar preguntas para tu llamada de especificación con YAPU.