API-Clients ermöglichen es Ihnen, externe Anwendungen oder Dienste mit Sonderplan über unsere RESTful-API zu integrieren. Jeder API-Client wird einem bestimmten Sonderplan-Benutzer zugewiesen, übernimmt 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 Anmeldeinformationen oder unbefugtem Zugriff, und es wird einfacher, Zugriffe zu prüfen, zu verwalten, Probleme zu beheben und präzise Berechtigungsbereiche durchzusetzen, die auf jede Integrationsszenario zugeschnitten sind.

​
Erstellung eines API-Clients

  1. Erweitern Sie Admin und klicken Sie auf Integrationen -> Neu -> Api Client, der Seitenleisten-Editor öffnet sich. Sonderplan neuer API-Client
  2. Geben Sie eine Beschreibung zum Zweck des API-Clients ein, zum Beispiel “Zapier-Client”
  3. 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.
  4. Klicken Sie auf Speichern, um den API-Client zu erstellen.
  5. Das Authentication Bearer Token wird nur einmal angezeigt. Stellen Sie sicher, dass Sie das Token kopieren, bevor Sie die Seitenleiste des API-Clients schließen. Sonderplan API-Authentifizierungstoken
API-Client-Token laufen nach einem Zeitraum von 5 Jahren ab, können aber sofort widerrufen und zurückgesetzt werden.

​
Bearbeiten eines API-Clients

Derzeit ist es nur möglich, die Beschreibung eines bestehenden API-Clients zu ändern. Um einen API-Client zu bearbeiten:
  1. Klicken Sie auf die Client Id in der API-Clients-Datentabelle, dadurch öffnet sich der Seitenleisten-Editor des API-Clients.
  2. Bearbeiten Sie das Beschreibung-Feld
  3. Klicken Sie auf Speichern

​
Löschen eines API-Clients

Das Löschen eines API-Clients widerruft sofort das Authentifizierungstoken, sodass es nicht mehr für Anfragen an die Sonderplan REST-API verwendet werden kann. Um einen API-Client zu löschen:
  1. Klicken Sie auf die Client Id in der API-Clients-Datentabelle, dadurch öffnet sich der Seitenleisten-Editor des API-Clients.
  2. Klicken Sie auf die -Schaltfläche in der unteren rechten Ecke des Editors.
  3. Klicken Sie auf die Löschen-Schaltfläche im Bestätigungs-Popup.
Sonderplan API-Client löschen

​
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.