Esta guía le explica los pasos para realizar su primera llamada a la 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 su propio código de aplicación
Paso 1 — Autenticarse con OAuth2
Las API de DQE utilizan autenticación mediante token Bearer de OAuth2. Antes de llamar a cualquier servicio, solicite un token:
- Llame al endpoint de OAuth2 con su código de licencia, su client secret y el scope del servicio al que desea acceder.
- Lea el token de acceso devuelto en la respuesta JSON.
- Inclúyalo como token
Beareren la cabeceraAuthorizationde sus solicitudes a la API.
Los tokens son válidos durante un periodo limitado; genere uno nuevo antes de que caduque.
Consultar 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 alfa-3 (por ejemplo, FRA para Francia, GBR para el Reino Unido).
Explorar todos los endpoints de la API →
Paso 3 — Probar con Swagger
DQE ofrece una interfaz Swagger para explorar y probar los endpoints de la API sin escribir código. Es la forma más rápida de entender los parámetros de solicitud y los formatos de respuesta antes de comenzar su integración.
La documentación de Swagger está disponible dentro de cada artículo de endpoint de la API. Explorar todos los endpoints de la API →
Notas importantes
- Las API de DQE están diseñadas para llamadas en tiempo real, registro por registro. No las utilice para procesamiento por lotes; utilice el procesamiento por lotes de 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 de la puesta en producción.
Artículos relacionados
Relacionada con