Kompass-API

Kompass ist ein innovativer, KI-gestützter Chatbot, der darauf ausgelegt ist, die Art und Weise zu revolutionieren, wie junge Menschen ihre Fähigkeiten erkennen, formulieren und präsentieren. Erfahren Sie mehr über die API, die Kompass antreibt.

Überblick und Format

Die Kompass Die API bietet sicheren Zugriff auf die Präferenzen, den Gesprächsstatus sowie die Erfahrungen und Fähigkeiten der Nutzer und ermöglicht so 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 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

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

• API-Schlüssel: Ein API-Schlüssel kann angefordert werden, indem die Administratoren über die angegebene E-Mail-Adresse kontaktiert werden. Nach der Ausgabe muss der API-Schlüssel in den x-api-key-Header jeder Anfrage aufgenommen werden. Zum Beispiel sollte der Header wie folgt formatiert sein: x-api-key: <Ihr-Zugriffstoken>.

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

Direkter Zugriff auf die OpenAPI-Spezifikation

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

• Link zur OpenAPI-Spezifikation: https://demo.compass.tabiya.tech/openapi.json

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

Nutzungsrichtlinien und Ratenbegrenzung

Um einen fairen und stabilen Zugriff für alle Nutzer zu gewährleisten, setzen wir eine Richtlinie zur Ratenbegrenzung durch. Entwickler sind auf 120 Anfragen pro Minute und eindeutigen API-Schlüssel begrenzt. Eine Überschreitung dieses Schwellenwerts führt sofort dazu, dass ein HTTP-Statuscode 429 "Too Many Requests" zurückgegeben wird, und nachfolgende Anfragen werden blockiert, bis die Minute zurückgesetzt wird.