Antes de iniciar: requisitos previos y herramientas útiles

Para comenzar a usar nuestras APIs, necesitas contar con ciertos conocimientos básicos y herramientas que faciliten la autenticación y las pruebas. En esta sección encontrarás lo necesario para preparar tu entorno de desarrollo y empezar a interactuar con los servicios disponibles en la plataforma DataInt.

1. Suscripción activa y credenciales de acceso

El primer paso para utilizar nuestras APIs es contar con una suscripción activa a DataInt. Una vez activada, el equipo de DataInt proporcionará un par de credenciales necesarias para autenticar tus peticiones:

• client_id
• client_secret

Estas credenciales son personales y están asociadas a tu organización. Son necesarias para obtener un token de acceso válido que te permitirá interactuar con los diferentes microservicios de forma segura.

Note

Si aún no tienes una suscripción, puedes solicitar más información a través de nuestro correo electrónico [email protected].

2. Herramientas recomendadas para pruebas

Para facilitar las pruebas y el desarrollo con nuestras APIs, recomendamos utilizar las siguientes herramientas:

Swagger UI y Postman

En la página de documentación de cada microservicio, encontrarás un archivo .json con la especificación completa de la API en formato OpenAPI. Este archivo contiene toda la información necesaria sobre endpoints, parámetros, tipos de datos y ejemplos de uso.

Puedes utilizar este archivo con las siguientes herramientas:

Swagger UI: Permite visualizar y probar la API directamente desde el navegador. Solo necesitas:

1. Descargar el archivo .json de la especificación OpenAPI
2. Importarlo en Swagger Editor o usar una instancia local
3. Realizar pruebas interactivas con la interfaz web

Postman: Una herramienta popular para testing de APIs que te permite:

1. Importar el archivo .json de OpenAPI directamente
2. Generar automáticamente una colección completa con todos los endpoints
3. Configurar variables de entorno para tus credenciales
4. Automatizar pruebas y crear flujos de trabajo

cURL

Para usuarios que prefieren la línea de comandos, cURL es una excelente opción. Te permite realizar peticiones HTTP directamente desde la terminal y es ideal para:

• Pruebas rápidas
• Integración en scripts
• Debugging de peticiones específicas

Herramientas de desarrollo del navegador

Las herramientas de desarrollo integradas en navegadores modernos (Chrome DevTools, Firefox Developer Tools) son útiles para:

• Inspeccionar peticiones y respuestas HTTP
• Debuggear aplicaciones web que consumen las APIs
• Monitorear el tráfico de red

Note

Te recomendamos comenzar con Postman o Swagger UI, especialmente si eres nuevo en el uso de APIs, ya que proporcionan una interfaz visual intuitiva para explorar y probar los endpoints.