Inhalt dieses Artikels
- Vorbemerkungen
- API Zugangs-Token erstellen
- plenigo API-Dokumentation
1. Vorbemerkungen
Ein API-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-Token, um unter anderem Integrationen zu plenigo zu programmieren.
API-Token können zusätzlich für unterschiedliche Anwendungsfälle, wie beispielsweise den Zugriff von Drittanwendungen oder Team-Mitglieder erstellt werden.
Über den Menüpunkt "Einstellungen" gelangst Du zum Unterpunkt "Entwicklung", "API Zugangs-Token".
2. API Zugangs-Token erstellen
Über den Button "Neuen API-Token erstellen" kann ein Token hinzugefügt werden.
Abb: API-Zugangs-Token erstellen
Das Formular ist folgendermaßen aufgebaut:
(1) "Name": Betitelt das Token
(2) "Zugriffsrechte": Legt fest, ob der Token zum "Lesen und Schreiben" oder zum "nur Lesen" benutzt werden kann.
(3) "Anwendungen": Legt fest, für welche Anwendungen der Token benutzt werden darf. Es kann auch ein Token mit allen Anwendungen erstellt werden.
Zusätzlich kann eine Beschreibung und ein Datum, an welchem der Token ablaufen soll, hinzugefügt werden.
Abb: Felder im Formular für einen API-Zugangs-Token
Hinweis: Nach dem Speichern kann ein API-Zugangs-Token nicht mehr geändert werden.
Mit klick auf den "Namen" des Tokens, öffnet sich die Detailansicht. Hier ist der erstellte Token zu sehen und kann über den Button "Kopie" (1) kopiert oder auch gelöscht (2) werden.
Abb: Detailansicht des erstellten Tokens
3. plenigo API-Dokumentation
In der plenigo API-Dokumentation findest Du alle nötigen Informationen, wie die API im Zusammenhang mit plenigo verwendet werden kann.