Wir befinden uns momentan in einer Übergangsphase zu neuen APIs, die mit v4 gekennzeichnet sind und auf getflip.dev dokumentiert sind. Selbstverständlich unterstützen wir weiterhin unsere bisherigen APIs und werden rechtzeitig im Voraus darüber informieren, sollten diese eingestellt werden.

Application Programming Interfaces oder kurz APIs werden von Anwendungen verwendet, um miteinander zu kommunizieren. Um über eine API auf Ressourcen zuzugreifen, muss sich die anfragende Anwendung als API-Client authentifizieren.

API-Clients können in der Admin Console > Zugang & Sicherheit > API-Clients erstellt und verwaltet werden.

In der Tabelle werden nur neue API-Clients angezeigt. Zuvor erstellte API-Clients werden nicht angezeigt und von unserem Customer Success Engineering Team verwaltet. Bitte kontaktiere sie für Änderungen.

Nach der Erstellung verhält sich ein API-Client wie ein normaler Benutzer im System. Der Benutzername lautet service-account-<client_id>.

Erstellen eines API-Clients

1. Öffne die Admin Console und navigiere anschließend zu Zugang & Sicherheit > API-Clients
2. Klicke auf die Schaltfläche „API-Client hinzufügen“ in der oberen rechten Ecke.
3. Gib die „Client-ID“ ein. Dies ist ein fester Wert und kann später nicht mehr geändert werden.
4. Durch Auswahl der „Rolle“ kannst du die Autorisierung dieses API-Clients festlegen. „Legacy-Rollen“ sind für unsere bisherigen APIs und nicht relevant, solltest du eine v4 API nutzen. Die Autorisierungsrollen können nachträglich geändert werden.
5. Gib den Vor- und Nachnamen ein, da jeder API-Client in der App als Benutzer angezeigt wird. Du kannst Vor- und Nachnamen nachträglich ändern.
6. Klicke auf „API-Client erstellen“.
7. ⚠️ Kopiere das Client Secret von der geöffneten Detail-Ansicht des API-Clients und speichere es sicher bei dir ab. Das Client Secret wird nicht erneut angezeigt. Wird es verloren, muss ein neuer Client angelegt werden.

API-Clients bearbeiten

Obwohl API-Clients wie normale Benutzer erscheinen, können sie nur unter Zugang & Sicherheit > API-Clients und nicht unter Benutzerverwaltung bearbeitet werden.

1. Klicke auf den API-Client, den du bearbeiten möchtest.
2. Klicke in der Detail-Ansicht auf „Bearbeiten“.
3. Du kannst die Beschreibung, die Rollen und die Profilinformationen bearbeiten.
4. Klicke auf „Änderungen speichern“.

API-Clients deaktivieren und wieder aktivieren

Klicke in der Detail-Ansicht des API-Clients, den du deaktivieren möchtest, auf „API-Client deaktivieren“.

Dadurch wird verhindert, dass Anwendungen neue Access Tokens erhalten, und somit der Zugriff auf das System gesperrt. Dies kann zu Problemen bestehender Integrationen oder Anbindungen führen, welche den API-Client verwenden.

Um einen API-Client wieder zu aktivieren, klicke auf „API-Client aktivieren“.

Löschen eines API-Clients

Klicke in der Detail-Ansicht des API-Clients, den du löschen möchtest, auf „API-Client löschen“.

⚠️ Durch das Löschen dieses API-Clients wird er dauerhaft aus dem System entfernt und kann nicht wiederhergestellt werden. Alle Anwendungen, die auf diesen Client angewiesen sind, können keine Access Tokens mehr erhalten und kann zu Problemen bestehender Integrationen oder Anbindungen führen, welche den API-Client verwenden.