Zum Hauptinhalt springen

Was muss ich bei der Einrichtung der API-Schnittstelle beachten?

Verfasst von Selina Rudolph
Diese Woche aktualisiert

Bei der Integration unserer API gibt es einige Punkte, die du bei der Einrichtung beachten solltest. Die folgenden Hinweise unterstützen dich bei der erfolgreichen Einrichtung der Schnittstelle.

➤ API-Dokumentation zur Einrichtung nutzen

Bei der Einrichtung der API hilft dir unsere Dokumentation Schritt für Schritt weiter und enthält alle wichtigen Informationen zur Authentifizierung und zu den verfügbaren Endpunkten. Die API-Doku findest du hier.

➤ Access Token korrekt erstellen

Der Zugriff auf die API erfolgt über einen Bearer Token, der über folgende URL angefordert wird:

Der Token wird über Client Credentials (ClientId und ClientSecret) generiert.

Hinweis:

  • Scopes müssen nicht angegeben werden.

  • Die passenden Scopes werden automatisch vergeben.

Wir empfehlen, den Access Token maximal einmal täglich neu anzufordern.

Das Freikontingent für Access Tokens je Kunde liegt bei 100 Access Tokens pro Monat. Jeder weitere Token kostet 0,10 €.

➤ Den richtigen Token verwenden

Bitte stelle sicher, dass du den access_token aus der Token-Response verwendest.
Ein eventuell vorhandener id_token funktioniert nicht für API-Requests.

➤ API-Request testen

Zum Test kannst du z. B. folgenden Endpunkt aufrufen:

Wenn der Token korrekt übermittelt wird, sollte der Request erfolgreich authentifiziert werden.

➤ User-Agent Header setzen

Die API erwartet einen gültigen User-Agent Header.
Fehlt dieser Header, kann der Request aus Sicherheitsgründen blockiert werden.

Warum das gemacht wird:

APIs verlangen manchmal einen User-Agent, um:

  1. Bots oder missbräuchliche Requests zu erkennen

  2. Clients identifizieren zu können (z. B. SDK, Script, App)

  3. Debugging und Logging zu erleichtern

  4. Standard-Browserverhalten zu simulieren

Empfohlen:

Mozilla/5.0 (talent360)

❗Häufige Fehlerquellen

  1. Falsche Audience im Token
    Die Audience muss https://api.talent360.io/api/v3 sein.

  2. Token wurde verändert oder abgeschnitten
    Beim Kopieren oder Weiterverarbeiten kann der Token abgeschnitten oder verändert werden.

  3. Unterschiedliche API-URLs

    In der API-Dokumentation werden aktuell zwei unterschiedliche URL-Strukturen verwendet.

    Für die OAuth-Authentifizierung ist als Audience folgende URL angegeben:

    Alle dokumentierten API-Endpunkte beginnen jedoch mit einer anderen Struktur und enthalten kein /api/. Stattdessen starten sie mit:

    Beispiel

    Hinweis

    Achte bei der Implementierung darauf, dass sich die URL für die Audience von den tatsächlichen API-Endpunkten unterscheiden kann. Die Audience enthält /api/v3, während alle Endpunkte direkt mit /V3 beginnen.

Hat dies deine Frage beantwortet?