Perk nutzt die Spend API (ehemals Yokoy API) für das Ausgabenmanagement. Die Spend API ist eine REST-API, mit der Konten Ausgaben einreichen, Transaktionen einsehen und Rechnungen in Perk verwalten können. Nur Kontoadministratoren und Entwickler können Zugangsdaten für die Yokoy API anfordern.
Tipp: Neu bei der Spend API? Schauen Sie sich Yokoy Developer an.
API-Zugangsdaten sind kontobezogen. Das bedeutet, dass sie Berechtigungen zum Ändern von Stammdaten für verschiedene juristische Personen besitzen.
Wenn Sie API-Anmeldedaten anfordern, erhalten Sie die Client-ID und das Client-Secret, mit denen ein Zugriffstoken für die Spend API erzeugt wird. Das generierte Zugriffstoken muss zur Authentifizierung aller Aufrufe der API verwendet werden. Zusätzlich benötigen Sie die Organisations-ID Ihres Kontos. Diese Informationen finden Sie oben rechts unter Developer tools > Spend tools.
Um ein Zugangs-Token zu erstellen, siehe Authentifizierung und Autorisierung. Die API-Credentials sind für die gesamte Organisation gültig, unabhängig davon, welche Benutzerin oder welcher Benutzer die Anfrage einreicht.
Sie können die API-Credentials im Tab Access credentials erzeugen.
API-Credentials erzeugen
So erzeugen Sie API-Anmeldedaten für die Yokoy API:
- Gehen Sie zu Developer tools > Spend tools. Öffnen Sie den Tab Access credentials, und klicken Sie auf Generate credentials, um neue API-Credentials zu erstellen.
-
Wählen Sie OAuth-Zugangsdaten und klicken Sie auf Credentials erzeugen.
- Geben Sie eine Kennzeichnung ein, um die API-Credentials zu beschreiben. Die Kennzeichnung hilft Ihnen, die Anmeldeinformationen zu identifizieren. Die Kennzeichnung muss eindeutig sein. Sie können erst fortfahren, wenn Sie eine eindeutige Kennzeichnung eingegeben haben. Klicken Sie anschließend auf Weiter.
- Kopieren Sie die Client-ID und das Client-Secret und speichern Sie diese sicher (z. B. in einer geschützten Datei). Die Credentials sind einmalig und können nicht wiederhergestellt werden. Bewahren Sie sie an einem sicheren Ort auf, damit Sie sie später erneut verwenden können. Um fortzufahren, müssen Sie bestätigen, dass Sie die Client-ID und das Client-Secret kopiert haben.
API-Credentials laufen nicht ab. Sie können die Credentials während dieser Zeit jederzeit widerrufen. Wenn Sie Ihre API-Credentials verlieren, müssen Sie den Zugang widerrufen und neue Credentials erstellen.
Sie können mehrere API-Credentials für die Verwendung in verschiedenen Anwendungen erstellen. API-Credentials werden nicht automatisch widerrufen, wenn Sie mehr als ein Set von Credentials erstellen.
Auf der Registerkarte „Entwickler“ werden alle API-Credentials angezeigt, die erstellt oder widerrufen wurden, einschließlich der Benutzerin oder des Benutzers, die bzw. der die Daten angefordert hat, sowie des Datums, an dem sie angefordert wurden.
Zugriff widerrufen
So widerrufen Sie den durch die API-Credentials gewährten Zugriff:
- In den Entwicklertools > AusgabentoolsZugangsdaten Klicken Sie auf die Registerkarte und wählen Sie die Aktion „Zugriff widerrufen“.Die
- Klicken Sie auf Zugang widerrufen, um die Credentials zu entfernen.
Vorsicht: Wenn der Zugang widerrufen wird, können andere Anwendungen oder Skripte, die dieses Token verwenden, nicht mehr auf Perk zugreifen. Daraufhin werden die API-Credentials auf der Entwicklerseite mit dem Status Widerrufen, dem Namen der Benutzerin oder des Benutzers, die bzw. der sie widerrufen hat, sowie dem Widerrufsdatum angezeigt.