Ce guide vous accompagne à travers les étapes pour effectuer votre premier appel à l'API DQE — de l'obtention des identifiants à l'appel d'un endpoint de service.
Prérequis
- Un code de licence DQE valide et un client secret (fournis par DQE)
- Un client HTTP ou votre propre code applicatif
Étape 1 — S'authentifier avec OAuth2
Les API DQE utilisent l'authentification par jeton Bearer OAuth2. Avant d'appeler un service, demandez un jeton :
- Appelez le endpoint OAuth2 avec votre code de licence, votre client secret, et le scope du service auquel vous souhaitez accéder.
- Lisez le jeton d'accès renvoyé dans la réponse JSON.
- Incluez-le comme jeton
Bearerdans l'en-têteAuthorizationde vos requêtes API.
Les jetons sont valides pendant une durée limitée — générez-en un nouveau avant son expiration.
Voir la documentation complète OAuth2 →
Étape 2 — Appeler un endpoint de service
Les API DQE prennent en charge les méthodes GET et POST. Les réponses sont toujours renvoyées au format JSON.
Pour certains services, le paramètre pays est obligatoire et doit utiliser le code pays ISO 3166-1 alpha-3 (par exemple FRA pour la France, GBR pour le Royaume-Uni).
Parcourir tous les endpoints API →
Étape 3 — Tester avec Swagger
DQE fournit une interface Swagger pour explorer et tester les endpoints API sans écrire de code. C'est le moyen le plus rapide de comprendre les paramètres de requête et les formats de réponse avant de démarrer votre intégration.
La documentation Swagger est disponible dans chaque article d'endpoint API. Parcourir tous les endpoints API →
Remarques importantes
- Les API DQE sont conçues pour des appels en temps réel, enregistrement par enregistrement. Ne les utilisez pas pour le traitement par lots — utilisez le traitement par lots basé sur des fichiers pour les opérations en masse.
- La mise en œuvre des appels API en mode bloquant relève de la seule responsabilité du client. DQE recommande des tests approfondis avant le déploiement en production.
Articles associés
Associé à