Inhalt dieses Artikels
- Vorbemerkungen
- API Zugangs-Token erstellen
- API Zugangs-Token verwalten
- plenigo API-Dokumentation
1. Vorbemerkungen
Ein API-Zugangs-Token ist ein eindeutiges Zuordnungsmerkmal, um die Daten des Unternehmens über die API abzurufen, zu verändern oder neu zu erzeugen. API-Token können für unterschiedliche Einsatzzwecke generiert und mit unterschiedlichen Berechtigungen ausgestattet werden. Entwickler-Teams benötigen API-Zugangs-Token, um unter anderem Integrationen zu plenigo zu programmieren. API-Zugangs-Token können zusätzlich für unterschiedliche Anwendungsfälle, wie beispielsweise den Zugriff von Drittanwendungen oder Team-Mitgliedern, erstellt werden.
In der Listenansicht zeigt die Spalte Status an, ob das Token aktiv oder abgelaufen ist. In der Spalte Alter des Tokens wird angezeigt, wie lange das Token bereits aktiv ist.
- älter als 6 Monate - Statussymbol steht auf Aktiv. Die Anzahl der Tage ist orange.
- älter als 1 Jahr - Statussymbol steht auf Aktiv. Die Anzahl der Tage ist rot.
-
abgelaufenes Token - Statussymbol steht auf Abgelaufen mit rotem Hintergrund
Hinweis: Aus Sicherheitsgründen empfehlen wir, das Token regelmäßig manuell zu erneuern oder die automatische Verlängerungsoption zu nutzen.
2. API Zugangs-Token erstellen
- +Neuen API-Token erstellen anklicken.
- Name* des Tokens vergeben.
- Beschreibung optional eingeben.
- Zugriffsrechte* bestimmt, ob das Token zum Lesen und Schreiben oder zum nur Lesen berechtigt.
- Anwendungen* mithilfe des Drop-Down-Menüs bestimmen, für welche Anwendungen das Token benutzt werden soll.
-
Erlischt am: Hier kann ein Datum definiert werden, an dem das Token verfällt. Sobald das Token verfällt, wird der Zugang zum plenigo System gesperrt.
- Checkbox Automatische Erneuerung alle x Tage: Wenn aktiviert, wird das Token automatisch erneuert und ein Callback kann eingestellt werden, um ein Drittsystem darüber zu informieren.
- E-Mail-Empfänger, an den die Information verschickt werden soll, dass sich das Token automatisch erneuert hat.
Callback Einstellungen
Es kann ein Callback eingerichtet werden, um die Information an ein Drittsystem zu übergeben, dass das API-Zugangstoken erneuert wurde. Callbacks müssen nur eingerichtet werden, wenn die automatische Erneuerung des Tokens aktiviert wurde. Der Callback übermittelt einen "unique key", der über den API-Endpunkt /apiAccessTokens/requestRenewedToken innerhalb von 2 Stunden eingelöst werden muss, um das aktualisierte Token zu erhalten. Wenn der "unique key" innerhalb von 2 Stunden nicht eingelöst wurde, wird nach 24 Stunden erneut ein Callback ausgelöst. Sobald der "unique key" verwendet wurde, ist das alte Token weitere 24 Stunden gültig, bevor es endgültig abläuft.
3. API-Zugangs-Token verwalten
Das Token kann entweder in der Liste rechts über Aktionen oder in der Detailansicht über die Aktionsleiste oben verwaltet werden.
Das Token kann nur in der Detailansicht erneuert werden!
Token kopieren
In der Detailansicht unterhalb des Tokens Kopie anklicken.
Das Token wird in den Zwischenspeicher kopiert und kann an anderer Stelle eingefügt werden.
Deaktivieren
- Deaktivieren anklicken.
- Im Dialogfenster wird noch einmal darauf aufmerksam gemacht, dass das Deaktivieren nicht rückgängig gemacht werden kann.
- Wenn das API-Zugangs-Token wirklich deaktiviert werden soll, Deaktivieren anklicken.
Bearbeiten
Das API-Zugangs-Token kann beschränkt bearbeitet werden.
Folgendes kann bearbeitet werden:
- Beschreibung
- automatische Erneuerung
- E-Mail-Empfänger
- Callback-Einstellungen
Token erneuern
In der Detailansicht in der Aktionsleiste kann das Token über Token erneuern manuell erneuert werden.
Folgendes muss/kann im Dialogfenster ausgefüllt werden:
- Enddatum des Tokens* bestimmt, wann das bestehende Token verfallen soll.
- Name des neuen Tokens* bestimmt den Namen des erneuerten Tokens.
- Beschreibung kann hinzugefügt werden.
4. plenigo API-Dokumentation
In der plenigo API-Dokumentation befinden sich alle nötigen Informationen, wie die API im Zusammenhang mit plenigo verwendet werden kann.