Compass API

Compass ist ein innovativer, KI-gestützter Chatbot, der darauf ausgelegt ist, die Art und Weise, wie eine junge Person ihre Fähigkeiten identifiziert, artikuliert und präsentiert, zu revolutionieren. Erfahren Sie mehr über die API, die Compass antreibt.

Übersicht und Format

Das Kompass API bietet sicheren Zugriff auf die Präferenzen der Nutzer, den Gesprächszustand sowie Erfahrungen und Fähigkeiten und ermöglicht eine nahtlose Integration in Ihre Anwendungen. Die Basis-URL für alle API-Anfragen ist https://demo.compass.tabiya.tech/api/docs. Um eine standardisierte Kommunikation sicherzustellen, verwenden alle Anfragen und Antworten (außer Datei-Uploads) das JSON-Format, was die Integration in jede moderne Programmierumgebung vereinfacht.

Zugangsdaten und Authentifizierung

Vor der Integration müssen Entwickler die erforderlichen Zugangsdaten erhalten.

• API-Schlüssel: Ein API-Schlüssel kann angefordert werden, indem die Administratoren über die dafür vorgesehene E-Mail kontaktiert werden. Nach Ausstellung muss der API-Schlüssel in der x-api-key Kopfzeile jeder Anfrage enthalten sein. Beispielsweise sollte die Kopfzeile wie folgt formatiert sein: x-api-key: <your-access-token>.

• Autorisierungs-Header: Diese sind compass-benutzerspezifisch und erfordern zunächst eine Anmeldung über die compass-App, um das Zugriffstoken zu erhalten.

Direkter Zugriff auf die OpenAPI-Spezifikation

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

• OpenAPI-Spezifikationslink: https://demo.compass.tabiya.tech/openapi.json

• Swagger-Link: https://demo.compass.tabiya.tech/api/docs

Nutzungsrichtlinien und Ratenbegrenzung

Um einen fairen und stabilen Zugang für alle Nutzer sicherzustellen, wenden wir eine Ratenbegrenzung an. Entwicklern sind maximal 120 Anfragen pro Minute pro einzigartigem API-Schlüssel gestattet. Ein Überschreiten dieser Grenze führt sofort zur Rückgabe des HTTP-Statuscodes 429 "Too Many Requests" und nachfolgende Anfragen werden blockiert, bis die Minute zurückgesetzt wird.