Zum Inhalt springen
OperumOperumHilfe-Center

API-Tokens verwalten

Mit einem API-Token kann eine angebundene Anwendung die API deines Arbeitsbereichs verwenden: Dienstlisten und Aufträge übertragen sowie gespeicherte Routen abrufen. Die Tokens verwaltest du in der App unter Mein Konto → API-Tokens.

  1. Melde dich mit dem Konto an, dessen Arbeitsbereich angebunden werden soll.
  2. Öffne Mein Konto und scrolle zu API-Tokens.
  3. Gib eine aussagekräftige Bezeichnung ein, beispielsweise „Anbindung Dispositionssystem“.
  4. Wähle unter Gültigkeit 30, 90 oder 365 Tage.
  5. Klicke auf API-Token erstellen.
  6. Wähle Token kopieren und hinterlege den Wert sicher in der angebundenen Anwendung.
  7. Schließe die Anzeige mit Token gesichert · schließen.
API-Tokens mit Bezeichnung, Gültigkeitsauswahl und API-Token erstellen
Unter Mein Konto legst du Bezeichnung und Gültigkeit für die Anbindung fest. Die Aufnahme zeigt das Formular vor dem Erstellen eines Tokens. Original-PNG öffnen ↗

Pro Konto sind bis zu 20 aktive Tokens möglich. Bei erreichtem Limit widerrufst du zuerst einen nicht mehr benötigten Token.

Die Liste zeigt Bezeichnung, gekürzten Präfix, Ablauf und letzte Verwendung. Noch nicht verwendet bedeutet, dass noch keine Nutzung registriert ist. Mit Aktualisieren lädst du die Liste erneut.

Ein Token funktioniert bis zu seinem Ablauf oder Widerruf. Bei Verlust oder Ablauf erstellst du einen neuen Token und ersetzt den Wert in der angebundenen Anwendung. Ein verlorener, möglicherweise noch gültiger Token sollte widerrufen werden.

  1. Suche den Token anhand der Bezeichnung und des Präfixes.
  2. Klicke auf Widerrufen.
  3. Bestätige mit Jetzt widerrufen.
  4. Prüfe den Status Widerrufen.

Die Anbindung verliert für nachfolgende Aufrufe sofort den Zugriff mit diesem Token. Für einen Wechsel kannst du zuerst einen neuen Token erstellen und in der Anbindung hinterlegen; anschließend widerrufst du den bisherigen.

Der Token gilt für die API unter /api/customer/v1 und für den Arbeitsbereich seines Erstellers. Er ermöglicht dort lesende Zugriffe und die unterstützten Importe. Er kann keine weiteren Tokens verwalten, keine vollständige Arbeitsbereichssicherung einspielen und keine Routenberechnung über den allgemeinen Solver starten.

API-Tokens liegen getrennt von den Planungsdaten. Gesamtsicherungen und der Verlauf enthalten keine Tokens; eine Wiederherstellung reaktiviert keinen widerrufenen Token.

Die technische Anbindung sendet den Wert im HTTP-Header:

Authorization: Bearer DEIN_TOKEN

Verwende den Token mit der Adresse deiner Operum-Instanz. Endpunkte, Importverhalten und Versionsschutz erklärt API anbinden.

Prüfe, ob der vollständige Wert übernommen wurde, ob er abgelaufen oder widerrufen ist und ob die Anbindung /api/customer/v1 verwendet. Für das Verwalten von Tokens brauchst du die normale Anmeldung in der App. Ein Token eines anderen Kontos öffnet dessen eigenen Arbeitsbereich.

Frage zur Anleitung