Paso 1. Contacte a su ejecutivo y presente su proyecto

El primer paso consiste en comunicarse con su ejecutivo o representante de negocio para exponer los objetivos de su proyecto y las necesidades de integración que desea cubrir:

Comprender

Comprender el objetivo funcional y técnico de la iniciativa.

Identificar

Identificar los procesos de negocio que requieren integración.

Analizar

Analizar los datos y servicios que serán necesarios.

Paso 2. Explore el Portal para Desarrolladores

Una vez comprendidas las necesidades del proyecto, se recomienda revisar detalladamente los recursos disponibles en este portal.
Aquí encontrará información que le permitirá identificar las APIs más adecuadas para su solución:

APIs disponibles

Consulte el catálogo completo de APIs, donde podrá conocer:

  1. Funcionalidad de cada servicio.
  2. Operaciones disponibles.
  3. Parámetros de entrada y salida.
  4. Ejemplos de solicitudes y respuestas.
  5. Especificaciones técnicas.

Casos de uso

Revise ejemplos prácticos de implementación para comprender cómo distintas APIs pueden utilizarse en escenarios reales de negocio.

Categorías de APIs

Las APIs están organizadas por categorías funcionales para facilitar su búsqueda e identificación. Esto le permitirá localizar rápidamente los servicios relacionados con su necesidad de negocio.

Paso 3. Solicite los accesos y recursos de integración

Una vez finalizado el análisis funcional y técnico, y cuando el proyecto se encuentre listo para iniciar el desarrollo, se gestionará la entrega de la información necesaria para la integración.

Se proporcionará un documento de incorporación que incluirá:

  • Credenciales de acceso al ambiente de Integración.
  • Información para la habilitación del ambiente de Producción cuando corresponda.
  • URLs y endpoints necesarios para el consumo de los servicios seleccionados.
  • Requisitos técnicos de conexión.
  • Información relacionada con autenticación y autorización.

Revisión obligatoria de la documentación de seguridad

Antes de iniciar cualquier desarrollo, es obligatorio revisar la sección de Seguridad disponible en este portal.

Esta documentación contiene información esencial sobre:

  • Mecanismos de autenticación.
  • Flujo de obtención y uso de credenciales.
  • Autorización y control de acceso.
  • Recomendaciones de seguridad.
  • Buenas prácticas de implementación.
  • Ejemplos de consumo de APIs.
  • Lineamientos para el uso adecuado de los ambientes.

La comprensión y aplicación de estas directrices es fundamental para garantizar una integración segura y exitosa.