Catálogo APIs

Appearance

Guía de uso de la documentación ​

Bienvenido a la guía rápida para aprovechar al máximo el Catálogo de APIs de ETB. Aquí encontrarás cómo navegar, consumir y sacar el mayor provecho a nuestros servicios.

¿Cómo está organizada la documentación? ​

  • Bienvenida: Introducción y visión general del portal de APIs.
  • Guía de uso: Este documento, con pasos y recomendaciones para integradores.
  • Secciones por servicio: Cada grupo de APIs está organizado por dominio (Atención, Clientes, Órdenes, Integraciones Externas, etc.).
  • Ejemplos y parámetros: Cada API incluye ejemplos de uso, parámetros requeridos y respuestas esperadas.

¿Cómo empezar a consumir las APIs? ​

  1. Revisa el Índice de APIs para identificar el servicio que necesitas.
  2. Lee la descripción y los ejemplos de cada endpoint.
  3. Verifica los parámetros obligatorios y opcionales.
  4. Realiza pruebas en entornos controlados antes de integrar en producción.
  5. Consulta las notas y advertencias específicas de cada API.

Buenas prácticas de integración ​

  • Utiliza siempre los endpoints documentados y actualizados.
  • Maneja correctamente los códigos de error y mensajes de respuesta.
  • Respeta los límites de uso y políticas de seguridad indicadas.
  • Mantén tus credenciales seguras y actualizadas.
  • Consulta frecuentemente la documentación para cambios o nuevas versiones.

Recursos y enlaces útiles ​

Soporte y contacto ​

Si tienes dudas, sugerencias o encuentras algún problema, contacta al equipo técnico a través de los canales oficiales indicados en la documentación o mediante tu contacto de soporte ETB.