Wie richte ich die DTAD-API ein?

Wie richte ich die DTAD API ein?

Um die DTAD API zu nutzen, fordern Sie Ihre Zugangsdaten (CLIENT_ID und CLIENT_SECRET) beim DTAD Customer Success Team an, erzeugen Sie damit ein JWT-Token und übermitteln Sie es bei jedem API-Aufruf im Authorization-Header. Die folgenden Schritte beschreiben den vollständigen Einrichtungsprozess.

Die DTAD API bietet Ihnen eine flexible und passgenaue Anbindung an Ihre bestehenden Systeme. Die technische Integration erfolgt durch Ihre eigenen Entwickler mit entsprechender Expertise oder durch einen von Ihnen beauftragten Dienstleister. Dank der übersichtlichen Dokumentation unter docs.dtad.com lässt sich die individuelle Anbindung einfach und unkompliziert umsetzen.

Schritt-für-Schritt-Anleitung zur API-Integration

1. API-Zugangsdaten erhalten

Ihre CLIENT_ID und CLIENT_SECRET erhalten Sie vom DTAD Customer Success Team. Bewahren Sie das CLIENT_SECRET sicher auf und veröffentlichen Sie es nicht im Quellcode oder in öffentlich zugänglichen Systemen.

2. JWT erzeugen

Fordern Sie mit Ihrer CLIENT_ID und Ihrem CLIENT_SECRET ein JWT an:

curl --location 'https://dtad-prod.auth.eu-central-
1.amazoncognito.com/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=CLIENT_ID' \
--data-urlencode 'client_secret=CLIENT_SECRET'

Ersetzen Sie CLIENT_ID und CLIENT_SECRET durch die bereitgestellten Zugangsdaten.

Das JWT ist 120 Minuten gültig. Fordern Sie rechtzeitig vor Ablauf dieser Zeit ein neues Token an, um Unterbrechungen in der API-Kommunikation zu vermeiden.

3. Authentifizierung übermitteln

Übermitteln Sie das JWT bei Ihren API-Aufrufen im Header Authorization.

4. API-Endpunkt aufrufen

Die Basis-URL der DTAD API lautet:

https://api.dtad.com

Je nach benötigten Daten steht eine Vielzahl von GET-Endpunkten zur Verfügung. Die vollständige URL setzt sich aus der Basis-URL und dem jeweiligen Endpunkt zusammen:

https://api.dtad.com/search-profiles/executions

Ausführliche Informationen zu den Endpunkten, Parametern und Antwortfeldern finden Sie in der DTAD API-Dokumentation.

5. Seitennummerierung berücksichtigen

Mehrere Endpunkte liefern paginierte Ergebnisse. Das bedeutet, dass die Datensätze auf mehrere Seiten verteilt werden. Dafür können Sie die Parameter page und limit verwenden:

https://api.dtad.com/search-profiles/executions?page=1&limit=25

Beim Endpunkt für Suchprofilausführungen beträgt der Standardwert für limit 25 und der Höchstwert 100. Die Antwort enthält unter anderem totalPages und currentPage. Um alle Seiten abzurufen, erhöhen Sie den page-Parameter schrittweise, bis currentPage gleich totalPages ist.

6. Antworten und Fehler verarbeiten

Die API liefert Daten im JSON-Format. Berücksichtigen Sie bei der Integration insbesondere folgende Statuscodes:

• 200: Die Anfrage war erfolgreich.
• 401: Die Anfrage ist nicht authentifiziert. Das JWT fehlt oder ist abgelaufen.
• 403: Der Zugriff ist nicht erlaubt. Das JWT ist gültig, aber die erforderlichen Berechtigungen fehlen.
• 404: Die angeforderten Daten wurden nicht gefunden.
• 500: Ein interner Serverfehler ist aufgetreten.

Prüfen Sie bei einem Statuscode 401, ob das JWT noch gültig ist und korrekt als Bearer-Token im Authorization-Header übermittelt wurde. Bei einem Statuscode 403 verfügt Ihr Account möglicherweise nicht über die erforderlichen Berechtigungen — wenden Sie sich in diesem Fall an das DTAD Customer Success Team.

Hinweis zu Anhängen

Der Endpunkt GET /attachments/{id} erzeugt einen öffentlichen Download-Link für den jeweiligen Anhang. Dieser Link bleibt nach seiner Erstellung 120 Sekunden gültig und sollte deshalb direkt verwendet werden. Die {id} entspricht der Anhang-ID, die in den Suchergebnissen als Feldwert zurückgegeben wird.