API der Open Taxonomy Platform

Arbeitsmärkte sind vielfältig und verändern sich schnell, daher muss eine nützliche Taxonomie auf transparente Weise lokalisierbar und anpassbar sein. Erfahren Sie mehr über die API, die unsere offene Taxonomieplattform antreibt.

Überblick und Format

Die Offene Taxonomie-Plattform API bietet sicheren Zugriff auf Taxonomiemodelle, Berufe, Fähigkeiten und deren jeweilige Gruppen und ermöglicht eine nahtlose Integration in Ihre Anwendungen. Die Basis-URL für alle API-Anfragen lautet https://taxonomy.tabiya.tech/taxonomy/api-doc/swagger/. Um eine standardisierte Kommunikation zu gewährleisten, verwenden alle Anfragen und Antworten (außer Datei-Uploads) das JSON-Format, wodurch sich die Integration in jede moderne Programmierumgebung unkompliziert gestaltet.

Anmeldedaten und Authentifizierung

Voraussetzungen

Bevor Sie die APIs integrieren können, müssen Sie die Anmeldedaten von den Plattformadministratoren erhalten. Anmeldedaten anfordern über die dafür vorgesehene E-Mail-Adresse auf dieser Seite. Je nach der von Ihnen gewählten Authentifizierungsmethode erhalten Sie:

• API-Schlüssel: Ein eindeutiger X-API-Key

• M2M OAuth: Ein URL des Autorisierungsservers, Client-ID, und Client-Secret

API-Pfadpräfixe

Alle Partner-APIs verwenden das folgende Pfadpräfix:

• /api/partner für API-Schlüssel

• /api/app Für JWT-Token, die über M2M OAuth empfangen werden.

Authentifizierungsmethoden

Wir unterstützen zwei Authentifizierungsmethoden. Wählen Sie diejenige, die Ihren Sicherheitsanforderungen entspricht.

API-Schlüssel

API-Schlüssel bieten einen einfachen Authentifizierungsmechanismus, der sich für grundlegende Integrationen eignet.

Verwendung

Fügen Sie den API-Schlüssel in jede Anfrage mithilfe des X-API-Key HTTP-Headers ein.

Beispiel:-

curl -X GET \\
  https://taxonomy.tabiya.tech/api/partner/info \\
  -H "X-API-Key: YOUR_API_KEY"

Machine-to-Machine (M2M) OAuth 2.0

Machine-to-Machine OAuth 2.0 ist die empfohlene Methode für eine sichere, automatisierte Service-zu-Service-Kommunikation mit kurzlebigen Zugriffstokens

Schritt 1

Senden Sie eine HTTP POST Anfrage an den URL des Autorisierungsservers unter Verwendung des Client-ID und Client-Secret.

Beispiel

curl -X POST YOUR_AUTHORIZATION_SERVER_URL \\
     -H "Content-Type: application/x-www-form-urlencoded" \\
     -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

Der Autorisierungsserver antwortet mit einem Zugriffstoken:

{
   "access_token": "YOUR_ACCESS_TOKEN",
   "token_type": "Bearer",
   "expires_in": 3600
}

Weitere Informationen finden Sie in der Auth-Token-Dokumentation zum Austausch von Client-Anmeldedaten gegen Zugriffstoken.

• https://docs.aws.amazon.com/cognito/latest/developerguide/token-endpoint.html#post-token-positive-exchanging-client-credentials-for-an-access-token-in-request-body

Schritt 2

Senden Sie eine Anfrage an die API mit dem Zugriffstoken aus dem vorherigen Ergebnis.

curl -X GET \\
   https://taxonomy.tabiya.tech/api/app/info \\
   -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Weitere Details finden Sie in der Scopes, M2M und Ressourcenserver Dokumentation auf AWS.

Direkter Zugriff auf die OpenAPI-Spezifikation

Zwei Zugriffsmethoden stehen für die API-Spezifikationen zur Verfügung. Die primäre Methode erfolgt über die interaktive Swagger-UI-Dokumentation, die das Durchsuchen und Live-Testen aller Endpunkte ermöglicht. Besonders wichtig: Für Entwickler, die ihre Clients schnell konfigurieren möchten, wird ein direkter, eigenständiger Link zur OpenAPI-v3-JSON-Spezifikationsdatei bereitgestellt. Dieser Link ist für Entwickler unerlässlich, die die gesamte API-Definition in Tools wie Postman oder Insomnia importieren möchten (mithilfe der Import > Link-Option), wodurch die Einrichtung beschleunigt wird, indem automatisch alle Endpunkt-, Parameter- und Schema-Definitionen generiert werden:

• Link zur OpenAPI-Spezifikation: https://taxonomy.tabiya.tech/api-doc/swagger/tabiya-api.json

• Swagger-UI-Link: https://taxonomy.tabiya.tech/api-doc/swagger/

• ReDoc-UI-Link: https://taxonomy.tabiya.tech/api-doc/redoc/