Authentifizierung und Zugriff

Ein Schlüssel identifiziert eine Integration

Ein Administrator verwaltet API-Schlüssel auf der Seite API & Integrationen der Anwendung. Ein Schlüssel gehört zu einer Gruppe, nicht zu einem einzelnen Mitarbeiter. Sie können mehrere benannte Schlüssel erstellen, ein Ablaufdatum oder unbegrenzte Gültigkeit festlegen, einen Schlüssel ersetzen und ihn widerrufen. Das vollständige Geheimnis wird nur einmal angezeigt; später zeigt die Oberfläche lediglich Präfix und Nutzungsinformationen. Bewahren Sie es in einem serverseitigen Secret Store auf, niemals in einem Browser oder einer mobilen Anwendung.

Senden Sie den Schlüssel bei jeder Anfrage an die Partner-API:

Authorization: Bearer YOUR_API_KEY

Fügen Sie in Scalars Feld Bearer Token nur den Schlüssel selbst ein. Scalar ergänzt den Präfix Bearer im HTTP-Header automatisch. Geben Sie dort keinen zweiten Präfix Bearer ein.

Für Partner gibt es keinen Login- oder Refresh-Token-Austausch. TrakarIA prüft den Schlüssel, seine Berechtigungen, den Status der Organisation und den kommerziellen Zugang. Ein widerrufener oder abgelaufener Schlüssel kann für nachfolgende Anfragen nicht mehr verwendet werden. Verwenden Sie getrennte Schlüssel für getrennte Systeme, damit Sie einen Schlüssel rotieren können, ohne andere Integrationen zu unterbrechen.

Jeder Vorgang erfordert eine bestimmte Berechtigung wie vehicles:read oder inspections:write. Wählen Sie anhand der Referenz der API-Schlüsselberechtigungen nur die Zugriffe, die Ihre Integration benötigt.

Ein Startlink benötigt weiterhin einen Menschen

Der API-Schlüssel authentifiziert Ihre Software. Ein Startlink bezeichnet die zu öffnende Inspektion, aber der Mitarbeiter muss sich zusätzlich in der TrakarIA-Oberfläche anmelden. Nehmen Sie den API-Schlüssel nicht in die Start-URL auf. Startlinks sind kurzlebig und können über die API erneuert werden.

API-Adresse

Senden Sie Anfragen an https://api.trakaria.com. GET /v1/capabilities zeigt für einen gültigen Schlüssel die tatsächlich verfügbaren Funktionen und Limits. Bevor Sie Datensätze im Konto anlegen, können Sie mit einer schreibgeschützten Anfrage beginnen.