Consolidate API: Authentifizierung

Dokumentation API
1

Authentifizierung

Die Consolidate API verwendet API-Schlüssel zur Authentifizierung aller Anfragen. Jede Anfrage an die API muss einen gültigen API-Schlüssel im Header enthalten.

  • Header-Name: X-API-Key
  • Wert: Ihr persönlicher API-Schlüssel

Anfragen ohne oder mit einem ungültigen API-Schlüssel werden mit dem HTTP-Statuscode 401 Unauthorized abgelehnt.

Wichtig: Behandeln Sie Ihre API-Schlüssel wie Passwörter und geben Sie sie nicht an Unbefugte weiter oder speichern Sie sie ungesichert im Quellcode.

1. API-Schlüssel generieren

Um einen API-Schlüssel zu generieren, benötigen Sie die entsprechende Berechtigung in Ihrem Benutzerprofil.

  • Falls Sie die Berechtigung nicht besitzen: Wenden Sie sich bitte an einen Administrator, um sie zu erhalten.
  • Wenn die Berechtigung vorhanden ist, können Sie wie folgt einen Schlüssel erstellen:
    1. Navigieren Sie zu den Einstellungen.
    2. Wählen Sie den Menüpunkt API Keys.
    3. Klicken Sie auf „Neuen API-Schlüssel erstellen“ und folgen Sie den Anweisungen.

Hinweis: Der API-Schlüssel wird Ihnen aus Sicherheitsgründen nur einmal vollständig angezeigt. Speichern Sie ihn sofort an einem sicheren Ort.

2. API-Schlüssel verwenden

Fügen Sie Ihren API-Schlüssel in den X-API-Key-Header jeder Anfrage ein, die Sie an die API senden.

Beispiel: Anfrage mit curl

Hier ist ein Beispiel, wie Sie eine Ressource mit curl abrufen und sich dabei authentifizieren:

curl -X POST "https://{IHRE_URL}/graphql" \
     -H "Content-Type: application/json" \
     -H "X-API-Key: IHR_PERSOENLICHER_API_SCHLUESSEL" \
     -d '{"query": "query { me { id user { email } } }"}'

Ersetzen Sie IHR_PERSOENLICHER_API_SCHLUESSEL durch den von Ihnen generierten Schlüssel. Achten Sie auch darauf dass Sie die richtige Basis-URL ihrer Instanz verwenden.

Verwaltung Ihrer API-Schlüssel

Im Bereich Einstellungen > API Keys finden Sie eine Übersicht aller von Ihnen generierten API-Schlüssel.

Diese Ansicht enthält nützliche Informationen wie:

  • Ein Label oder einen Namen (falls vergeben)
  • Das Erstellungsdatum
  • Das Datum der letzten Verwendung

Hier können Sie nicht mehr benötigte Schlüssel auch widerrufen (löschen), um die Sicherheit zu gewährleisten.