Ce guide vous accompagne dans les étapes pour effectuer votre premier appel à une 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 d'application
Étape 1 — S'authentifier avec OAuth2
Les API DQE utilisent l'authentification par token Bearer OAuth2. Avant d'appeler un service, demandez un token :
- Appelez l'endpoint OAuth2 avec votre code de licence, votre client secret, et le scope du service auquel vous souhaitez accéder.
- Récupérez le token d'accès renvoyé dans la réponse JSON.
- Incluez-le en tant que token
Bearerdans l'en-têteAuthorizationde vos requêtes API.
Les tokens sont valides pour une durée limitée — générez-en un nouveau avant son expiration.
Voir la documentation OAuth2 complète →
É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 country 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 d'API →
Étape 3 — Tester l'API de manière interactive
De nombreux articles d'API DQE incluent une console "Tester l'API" en direct qui vous permet d'explorer et de tester les endpoints directement dans votre navigateur, sans écrire aucun code — 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.
Une console interactive, accompagnée d'exemples de code prêts à l'emploi dans plusieurs langages, est disponible dans chaque article d'endpoint d'API pris en charge. Parcourir tous les endpoints d'API →
Points importants
- Les API DQE sont conçues pour des appels en temps réel, enregistrement par enregistrement. Ne les utilisez pas pour du traitement par lot — utilisez le traitement par lot basé sur 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é à