Einstieg
- PLANTA link → Web-Schnittstellen → Konfiguration → Web-Schnittstellen → Schaltfläche API-Tokens verwalten → API-Tokens verwalten
- PLANTA link → Web-Schnittstellen → API-Tokens verwalten
Information
- In diesem Modul werden neue Tokens generiert oder vorhandene Tokens den Web-Schnittstellen zugeordnet
Vorgehensweise: einen neuen Token generieren
- Das Modul API-Tokens verwalten öffnen. Dabei wird bereits ein leerer Datensatz für einen neuen Token angezeigt.
- Im Feld Notiz eine Bezeichnung oder eine Beschreibung einfügen und speichern. Die ID für den neuen Token wird automatisch generiert.
- Wird das Modul direkt aus der Konfiguration einer Web-Schnittstelle geöffnet und ein neuer Token wird generiert, wird dieser automatisch der geöffneten Web-Schnittstelle zugeordnet.
- Ein Token auf ungültig gesetzt werden, indem für ihn
- die Checkbox Gültig manuell deaktiviert wird oder
- im Feld bis ein Ablaufdatum vorgegeben wird, an dem (gesteuert über ein Event) die Checkbox Gültig automatisch deaktiviert wird.
Vorgehensweise: einen Token einer Web-Schnittstelle zuordnen
- Das Modul API-Tokens verwalten öffnen.
- Auf einen gewünschten Token rechtsklicken und Einfügen → API-Token-Zuordnung aus dem Kontextmenü auswählen.
- Speichern. Die zugeordnete Web-Schnittstelle ist sofort unter dem Token-Datensatz ersichtlich.
Details
- Es ist möglich, einen Token mehreren Web-Schnittstellen zuzuordnen.
- Es können mehrere Tokens für verschiedene Gruppen von Web-Schnittstellen existieren.
- Es ist zum Beispiel möglich, einen Token zu generieren und für alle Jira-Endpunkte oder alle PLANTA pulse-Endpunkte zu nutzen, um ein Fremdsystem komfortabel anzubinden, ohne zu viele Tokens verwalten zu müssen.
- Es ist möglich die API-Tokens für die pulse/jira Hybrid Schnittstellen über Umgebungsvariablen zu setzen.
- planta__server__api_token__pulse = ac52d48bc316424f8f541b3855552d7e
- planta__server__api_token__jira = 187658bcc7c14817b4679fd58581c3ec
- Der API Token muss dem Format einer UUID entsprechen. Wenn der Server startet, wird der Token angelegt. Ist bereits ein Token vergeben, passiert nichts.