Open Taxonomy Platform API

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

Übersicht und Format

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

Zugangsdaten und Authentifizierung

Voraussetzungen

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

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

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

API-Pfadpräfixe

Alle Partner-APIs verwenden folgendes 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 die Methode, die Ihren Sicherheitsanforderungen entspricht.

API-Schlüssel

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

Verwendung

Fügen Sie den API-Schlüssel in jeder Anfrage über den X-API-Key HTTP-Header 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 sichere, automatisierte Service-zu-Service-Kommunikation unter Verwendung kurzlebiger Zugriffstoken

Schritt 1

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

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-Anmeldeinformationen 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"

Für weitere Details siehe die Scopes, M2M, and resource servers Dokumentation auf AWS.

Direkter Zugriff auf die OpenAPI-Spezifikation

Für die API-Spezifikationen stehen zwei Zugriffsmethoden zur Verfügung. Die primäre Methode ist die interaktive Swagger-UI-Dokumentation, die das Durchsuchen und Live-Testen aller Endpunkte ermöglicht. Wichtig für Entwickler, die ihre Clients schnell konfigurieren möchten, ist ein direkter, eigenständiger Link zur OpenAPI v3 JSON-Spezifikationsdatei verfügbar. Dieser Link ist wesentlich für Entwickler, die die gesamte API-Definition in Tools wie Postman oder Insomnia importieren möchten (unter Verwendung der Import > Link-Option), was die Einrichtung beschleunigt, indem automatisch alle Endpunkt-, Parameter- und Schemadefinitionen generiert werden:

• OpenAPI-Spezifikationslink: 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/