🌐Web-App | 👤 Entwickler (Admin)
Die Yokoy-API ist eine REST-API, mit der Organisationen Ausgaben einreichen, Transaktionen einsehen und Rechnungen in Yokoy verwalten können. Nur Benutzer mit der Entwickler-Rolle können API-Credentials für die Yokoy-API anfordern.
💡 Tipp
Neu bei der Yokoy API? Schau Dir den Yokoy Developer an (nur in englischer Sprache verfügbar).
🚧 Benutzer mit Entwickler-Rolle und API-Credentials
Benutzer mit der Entwickler-Rolle sind organisationsübergreifend. Das bedeutet, dass sie die Berechtigung haben, Stammdaten für die verschiedenen Firmen zu ändern, sobald sie über API-Credentials verfügen.
Wenn Du API-Credentials anforderst, erhältst Du die Client-ID und das Client-Secret, die verwendet werden, um ein Zugangs-Token für die Yokoy-API zu erzeugen. Das generierte Zugriffs-Token muss für die Authentifizierung aller Aufrufe der API verwendet werden.
Um ein Zugangs-Token zu erstellen, siehe Authentifizierung und Autorisierung. Die API-Credentials sind für die gesamte Organisation gültig, unabhängig davon, welcher Nutzer die Anfrage einreicht.
Du kannst die API-Credentials in Yokoy selbst erstellen, wenn Du die Entwickler Rolle hast. Wenn Du kein Entwickler bist, musst Du Deinen Yokoy-Administrator um die Erlaubnis bitten, diese Aufgabe durchzuführen.
API-Credentials erzeugen
So generierst Du API-Credentials für die Yokoy-API:
Gehe zu Admin > Entwickler (unten im Admin-Menü). Um neue API-Credentials zu erstellen, klicke auf + Credentials erzeugen.
Wähle OAuth Zugriffsdaten und klicke auf Credentials erzeugen.
Gib eine Kennzeichnung ein, um die API-Credentials zu beschreiben. Die Kennzeichnung hilft dir, die Anmeldeinformationen zu identifizieren. Die Kennzeichnung muss eindeutig sein. Du kannst erst fortfahren, wenn Du eine eindeutige Kennzeichnung eingegeben hast. Klicke auf Weiter.
Kopiere die Client-ID und das Client-Secret und speichere sie sicher (z. B. in einer geschützten Datei). Die Credentials sind einmalig und können nicht wiederhergestellt werden. Bewahre sie an einem sicheren Ort auf, damit Du sie später wieder verwenden kannst. Um fortzufahren, musst Du bestätigen, dass Du die Client-ID und das Client-Secret kopiert hast.
API-Credentials laufen nicht ab. Du kannst die Credentials während dieser Zeit jederzeit widerrufen. Wenn Du Deine API-Credentials verlierst, musst Du den Zugang widerrufen und neue Credentials erstellen.
Du kannst mehrere API- Credentials für die Verwendung in verschiedenen Anwendungen erstellen.
API-Credentials werden nicht automatisch widerrufen, wenn Du mehr als einen Set von Credentials erstellst.
Auf der Registerkarte Entwickler werden alle API-Credentials angezeigt, die erstellt oder widerrufen wurden, einschließlich des Nutzers, der die Daten angefordert hat, und des Datums, an dem sie angefordert wurden.
Zugriff widerrufen
So widerrufst Du den durch die API-Credentials gewährten Zugriff:
Klicke auf der Registerkarte Entwickler auf die Aktion Zugang widerrufen.
Klicke 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 Yokoy zugreifen.
Daraufhin werden die API-Credentials auf der Entwicklerseite mit dem Status Widerrufen und dem Namen des Nutzers, der sie widerrufen hat, sowie dem Widerrufsdatum angezeigt.
