LocalUpHilfecenter
DE
Hilfecenter / Entwickler
Anleitung

Einen API-Schlüssel erstellen

Erstellen Sie einen API-Schlüssel mit den richtigen Berechtigungen, bewahren Sie das Token sicher auf und senden Sie Ihre erste API-Anfrage.

Mit einem API-Schlüssel kann ein Programm über die LocalUp-API oder den MCP-Server auf die Daten Ihres Kontos zugreifen. Diese Anleitung zeigt, wie Sie einen Schlüssel mit nur dem nötigen Zugriff erstellen und ihn sicher aufbewahren.

Bevor Sie beginnen:

  • Der API-Zugriff muss für Ihr Konto aktiviert sein (der Menüpunkt API ist in der Seitenleiste), und Ihre Rolle muss die Verwaltung von API-Schlüsseln erlauben.
  • Klären Sie, was die Integration tun soll — Bewertungen lesen, Standorte aktualisieren, einen KI-Assistenten verbinden —, damit Sie die minimal nötigen Berechtigungen wählen können.

Schritte

  1. Öffnen Sie Sonstiges → API.
  2. Klicken Sie unter API-Schlüssel auf Schlüssel erstellen.
  3. Geben Sie einen eindeutigen Namen ein, der sagt, wo der Schlüssel verwendet wird, zum Beispiel Production · backend.
  4. Markieren Sie die Berechtigungen, die die Integration benötigt. Wählen Sie so wenige wie möglich. Um einen KI-Assistenten über den MCP-Server zu verbinden, schließen Sie mcp:connect ein.
  5. Klicken Sie im Dialog auf Schlüssel erstellen.
  6. Das Fenster Token speichern zeigt das vollständige Token. Es wird nur dieses eine Mal angezeigt. Kopieren Sie es und bewahren Sie es an einem sicheren Ort auf, etwa in Ihrem Passwort-Manager oder im Geheimnisspeicher Ihres Servers.
  7. Klicken Sie auf Fertig.

Wichtig: Behandeln Sie das Token wie ein Passwort. Fügen Sie es nie in Website-Code ein, der in den Browsern der Besucher läuft, und teilen Sie es nie per E-Mail oder Chat.

Prüfen, ob es funktioniert hat

Senden Sie eine Testanfrage mit dem Token — der Block Schnellstart auf dem API-Bildschirm zeigt ein Beispiel:

curl https://<your cabinet address>/api/v1/locations \
  -H "Authorization: Bearer <your token>"

Eine erfolgreiche Antwort liefert Ihre Standorte. Auf dem API-Bildschirm wird das Datum Zuletzt verwendet des Schlüssels aktualisiert, und der Aufruf erscheint unter Anfrageprotokolle.

Einen Schlüssel rotieren oder widerrufen

  • Wenn das Token möglicherweise offengelegt wurde, oder als regelmäßige Vorsichtsmaßnahme, verwenden Sie Rotieren in der Zeile des Schlüssels. Ein neues Token wird einmalig angezeigt; das alte funktioniert sofort nicht mehr — aktualisieren Sie jede Integration, die es verwendet.
  • Wird der Schlüssel nicht mehr benötigt, verwenden Sie Widerrufen. Aufrufe damit schlagen sofort fehl. Dies lässt sich nicht rückgängig machen.

Fehlerbehebung

  • „Schlüsselname ist erforderlich“ / „Wählen Sie mindestens eine Berechtigung“. Geben Sie den Namen ein und markieren Sie mindestens eine Berechtigung.
  • Anfragen liefern 401. Das Token ist falsch, unvollständig, widerrufen oder rotiert. Prüfen Sie den Header Authorization: Bearer ….
  • Anfragen liefern 403. Dem Schlüssel fehlt eine Berechtigung, die der Endpunkt benötigt. Die API-Referenz nennt die erforderlichen Berechtigungen pro Endpunkt; erstellen Sie einen Schlüssel mit den richtigen Berechtigungen.
  • Anfragen liefern 429. Sie haben das Limit pro Minute überschritten. Warten Sie die im Header Retry-After angegebene Zeit ab.
  • Ich habe das Token verloren. Es kann nicht erneut angezeigt werden. Rotieren Sie den Schlüssel, um ein neues Token zu erhalten.

Verwandte Artikel