Dieser Leitfaden führt Sie durch die Schritte für Ihren ersten DQE-API-Aufruf – vom Erhalt der Zugangsdaten bis zum Aufruf eines Dienst-Endpunkts.
Voraussetzungen
- Ein gültiger DQE-Lizenzcode und Client Secret (von DQE bereitgestellt)
- Ein HTTP-Client oder Ihr eigener Anwendungscode
Schritt 1 – Authentifizierung mit OAuth2
DQE-APIs verwenden die OAuth2-Bearer-Token-Authentifizierung. Fordern Sie vor dem Aufruf eines Dienstes ein Token an:
- Rufen Sie den OAuth2-Endpunkt mit Ihrem Lizenzcode, Client Secret und dem Scope des Dienstes auf, auf den Sie zugreifen möchten.
- Lesen Sie das in der JSON-Antwort zurückgegebene Zugriffstoken.
- Fügen Sie es als
Bearer-Token imAuthorization-Header Ihrer API-Anfragen ein.
Tokens sind nur für einen begrenzten Zeitraum gültig – generieren Sie ein neues, bevor es abläuft.
Vollständige OAuth2-Dokumentation ansehen →
Schritt 2 – Einen Dienst-Endpunkt aufrufen
DQE-APIs unterstützen sowohl GET- als auch POST-Methoden. Antworten werden immer im JSON-Format zurückgegeben.
Bei einigen Diensten ist der Parameter country obligatorisch und muss den ISO-3166-1-Alpha-3-Ländercode verwenden (z. B. FRA für Frankreich, GBR für das Vereinigte Königreich).
Alle API-Endpunkte durchsuchen →
Schritt 3 – Mit Swagger testen
DQE bietet eine Swagger-Oberfläche, um API-Endpunkte zu erkunden und zu testen, ohne Code schreiben zu müssen. Dies ist der schnellste Weg, um Anfrageparameter und Antwortformate zu verstehen, bevor Sie mit Ihrer Integration beginnen.
Die Swagger-Dokumentation ist in jedem API-Endpunkt-Artikel verfügbar. Alle API-Endpunkte durchsuchen →
Wichtige Hinweise
- DQE-APIs sind für Echtzeit-Aufrufe einzelner Datensätze konzipiert. Verwenden Sie sie nicht für die Stapelverarbeitung – nutzen Sie für Massenvorgänge die dateibasierte Stapelverarbeitung.
- Die Implementierung von API-Aufrufen im Blockiermodus liegt in der alleinigen Verantwortung des Kunden. DQE empfiehlt ausführliche Tests vor der Produktionsbereitstellung.
Verwandte Artikel
Verknüpfung mit