API-Clients
Erstellen und konfigurieren Sie API-Clients, um benutzerdefinierte Anwendungen mit RESTful-APIs zu entwickeln, die flexible Integration und Entwicklung ermöglichen.
API-Clients ermöglichen die Integration externer Anwendungen oder Dienste mit Sonderplan über unsere RESTful-API. Jeder API-Client wird einem bestimmten Sonderplan-Benutzer zugeordnet, erbt dessen Benutzergruppenberechtigungen und stellt sicher, dass die externe Anwendung nur Aktionen ausführen kann, die für diesen Benutzer autorisiert sind. Dies bietet einen sicheren und präzisen Mechanismus zur Verwaltung von Integrationspunkten, benutzerdefinierten Anwendungen und automatisierten Workflows.
Wir empfehlen, für jeden Anwendungsfall oder jede Integration separate API-Clients zu erstellen. Durch die Isolierung der API-Clients verringern Sie Risiken im Zusammenhang mit der Offenlegung von Zugangsdaten oder unbefugtem Zugriff, und es wird einfacher, Zugriffe zu prüfen und zu verwalten, Probleme zu beheben und präzise Berechtigungsbereiche durchzusetzen, die auf jede Integrationsszenario zugeschnitten sind.
Erstellung eines API-Clients
-
Erweitern Sie Admin und klicken Sie auf Integrationen -> Neu -> Api Client, der Seitenleisten-Editor öffnet sich.
-
Geben Sie eine Beschreibung zum Zweck des API-Clients ein, zum Beispiel “Zapier-Client”
-
Wählen Sie den Benutzer aus, mit dem dieser API-Client verknüpft werden soll. Der API-Client erhält die gleichen Berechtigungen wie der Benutzer
Wir empfehlen, einen dedizierten Benutzer für Ihre API-Integrationen zu erstellen, der in einer Benutzergruppe mit möglichst wenigen Berechtigungen platziert ist. -
Klicken Sie auf Speichern, um den API-Client zu erstellen.
-
Das Authentifizierungs-Bearer-Token wird nur einmal angezeigt. Stellen Sie sicher, dass Sie das Token kopieren, bevor Sie die Seitenleiste des API-Clients schließen.
Bearbeitung eines API-Clients
Derzeit ist es nur möglich, die Beschreibung eines bestehenden API-Clients zu ändern.
Um einen API-Client zu bearbeiten:
- Klicken Sie auf die Client Id in der API-Clients-Datentabelle, dies öffnet die Seitenleisten-Editor des API-Clients.
- Bearbeiten Sie das Beschreibung-Feld
- Klicken Sie auf Speichern
Löschen eines API-Clients
Das Löschen eines API-Clients widerruft sofort das Authentifizierungs-Token, sodass es nicht mehr für Anfragen an die Sonderplan-REST-API verwendet werden kann.
Um einen API-Client zu löschen:
- Klicken Sie auf die Client Id in der API-Clients-Datentabelle, dies öffnet die Seitenleisten-Editor des API-Clients.
- Klicken Sie auf die -Schaltfläche in der unteren rechten Ecke des Editors.
- Klicken Sie auf die Löschen-Schaltfläche im Bestätigungs-Popup.
Weitere Ressourcen
Sonderplan REST API-Dokumentation
Entdecken Sie unsere umfassende REST-API-Dokumentation, um leistungsstarke Integrationen zu erstellen, Aufgaben zu automatisieren und die Fähigkeiten Ihres Unternehmens zu erweitern.
Sonderplan Zapier-Connector
Richten Sie einen neuen API-Client ein, integrieren Sie ihn mit Zapier und erstellen Sie einen Test-Zap, um Workflows zu automatisieren und Datenverbindungen zu optimieren.