Esta guía te acompaña en los pasos para realizar tu primera llamada a una API de DQE — desde la obtención de las credenciales hasta la llamada a un endpoint de servicio.
Requisitos previos
- Un código de licencia DQE válido y un client secret (proporcionados por DQE)
- Un cliente HTTP o tu propio código de aplicación
Paso 1 — Autenticarse con OAuth2
Las API de DQE utilizan autenticación mediante token Bearer OAuth2. Antes de llamar a cualquier servicio, solicita un token:
- Llama al endpoint de OAuth2 con tu código de licencia, tu client secret, y el scope del servicio al que deseas acceder.
- Obtén el token de acceso devuelto en la respuesta JSON.
- Inclúyelo como token
Beareren la cabeceraAuthorizationde tus solicitudes a la API.
Los tokens son válidos durante un período limitado — genera uno nuevo antes de que caduque.
Ver la documentación completa de OAuth2 →
Paso 2 — Llamar a un endpoint de servicio
Las API de DQE admiten los métodos GET y POST. Las respuestas siempre se devuelven en formato JSON.
Para algunos servicios, el parámetro country es obligatorio y debe utilizar el código de país ISO 3166-1 alpha-3 (por ejemplo, FRA para Francia, GBR para el Reino Unido).
Explorar todos los endpoints de API →
Paso 3 — Probar la API de forma interactiva
Muchos artículos de API de DQE incluyen una consola "Probar la API" en vivo que te permite explorar y probar los endpoints directamente desde tu navegador, sin escribir ningún código — la forma más rápida de entender los parámetros de solicitud y los formatos de respuesta antes de comenzar tu integración.
Una consola interactiva, junto con ejemplos de código listos para usar en varios lenguajes, está disponible en cada artículo de endpoint de API compatible. Explorar todos los endpoints de API →
Notas importantes
- Las API de DQE están diseñadas para llamadas en tiempo real, registro por registro. No las utilices para procesamiento por lotes — utiliza el procesamiento por lotes basado en archivos para operaciones masivas.
- La implementación de llamadas a la API en modo bloqueante es responsabilidad exclusiva del cliente. DQE recomienda realizar pruebas exhaustivas antes del despliegue en producción.
Artículos relacionados
Relacionada con