Diese Anleitung führt Sie durch die Schritte für Ihren ersten DQE-API-Aufruf — von der Beschaffung der Zugangsdaten bis zum Aufruf eines Service-Endpunkts.
Voraussetzungen
- Ein gültiger DQE-Lizenzcode und ein 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. Bevor Sie einen Dienst aufrufen, fordern Sie ein Token an:
- Rufen Sie den OAuth2-Endpunkt mit Ihrem Lizenzcode, Ihrem Client Secret und dem Scope des Dienstes auf, auf den Sie zugreifen möchten.
- Lesen Sie das in der JSON-Antwort zurückgegebene Zugriffstoken aus.
- Fügen Sie es als
Bearer-Token imAuthorization-Header Ihrer API-Anfragen ein.
Tokens sind nur für einen begrenzten Zeitraum gültig — erzeugen Sie vor Ablauf ein neues.
Vollständige OAuth2-Dokumentation ansehen →
Schritt 2 — Einen Service-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 — Die API interaktiv testen
Viele DQE-API-Artikel enthalten eine Live-Konsole "API testen", mit der Sie Endpunkte direkt in Ihrem Browser erkunden und testen können, ohne Code zu schreiben — der schnellste Weg, Anfrageparameter und Antwortformate zu verstehen, bevor Sie mit der Integration beginnen.
Eine interaktive Konsole sowie einsatzbereite Codebeispiele in mehreren Sprachen stehen in jedem unterstützten API-Endpunkt-Artikel zur Verfügung. Alle API-Endpunkte durchsuchen →
Wichtige Hinweise
- DQE-APIs sind für Echtzeit-Aufrufe mit jeweils einem einzelnen Datensatz konzipiert. Verwenden Sie sie nicht für die Stapelverarbeitung — nutzen Sie die dateibasierte Stapelverarbeitung für Massenvorgänge.
- Die Implementierung von API-Aufrufen im blockierenden Modus liegt in der alleinigen Verantwortung des Kunden. DQE empfiehlt gründliche Tests vor der Produktivbereitstellung.
Verwandte Artikel
Verknüpfung mit