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

Die Kompass Die API bietet sicheren Zugriff auf die Präferenzen der Nutzer, den Gesprächsstatus 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 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

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

• API-Schlüssel: Ein API-Schlüssel kann angefordert werden, indem Sie die Administratoren über die dafür vorgesehene E-Mail kontaktieren. Sobald er ausgestellt wurde, muss der API-Schlüssel im Header x-api-key jeder Anfrage enthalten sein. Zum Beispiel sollte der Header wie folgt formatiert sein: x-api-key: <your-access-token>.

• Autorisierungs-Header: Diese sind compass-benutzerspezifisch und erfordern zunächst das Einloggen über die compass-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 die interaktive Swagger-UI-Dokumentationsseite, die das Durchsuchen und Live-Testen aller Endpunkte ermöglicht. Wichtig 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 essenziell für Entwickler, die die gesamte API-Definition in Tools wie Postman oder Insomnia importieren möchten (unter Verwendung des Import > Link-Option), was die Einrichtung beschleunigt, indem automatisch alle Endpunkt-, Parameter- und Schemadefinitionen 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 zu gewährleisten, setzen wir eine Ratenbegrenzungsrichtlinie durch. Entwicklern sind 120 Anfragen pro Minute pro eindeutigen API-Schlüssel erlaubt. Das Überschreiten dieses Grenzwerts führt sofort zur Rückgabe des HTTP-Statuscodes 429 „Too Many Requests“ und nachfolgende Anfragen werden blockiert, bis die Minute zurückgesetzt wird.