Zum Hauptinhalt springen

API und Webhooks

Sie können SmartLink mit jeder Software (LDAP, SOC, Google Suite, ...) über die SmartLink-API und die Webhooks integrieren!

Diese Funktionen sind nur für die Lizenzen Platinum und Enterprise verfügbar.

Die SmartLink-API ermöglicht es Ihnen, Anfragen an Ihren SmartLink zu senden (z. B. Apps abrufen, Benutzer erstellen, ...) für Ihre Integrationen.

Webhooks ermöglichen es, Daten an die von Ihnen gewählte URL zu senden, wenn Ereignisse ausgelöst werden (z. B. Benutzererstellung, Benutzeranmeldung, ...).

Webhooks​

Zugriff auf den Webhooks-Tab​

Navigieren Sie zu Konfiguration über die Seitenleiste und wählen Sie dann den Tab Webhooks aus.

Navigieren Sie zu Konfiguration und dann zum Tab Webhooks

01.webhooks-tab-overview

Webhooks-Dokumentation​

Klicken Sie hier, um zur vollständigen Dokumentation der SmartLink-Webhooks zu gelangen (Liste der verfügbaren Ereignisse, Payload-Format, ...)

Klicken Sie auf den Link Öffnen Sie die vollständige SmartLink-Webhooks-Dokumentation, um zur vollständigen Dokumentation der Webhooks zu gelangen: Liste der verfügbaren Ereignisse, Payload-Format, Integrationsbeispiele.

Endpunkt hinzufügen​

Klicken Sie auf die Schaltfläche Endpunkt hinzufügen in der Symbolleiste, um einen neuen Webhook zu konfigurieren.

Klicken Sie auf Endpunkt hinzufügen, um einen neuen Webhook zu konfigurieren

Ein Seitenbereich öffnet sich mit dem Konfigurationsformular.

04.add-endpoint-form

Endpunkt konfigurieren​

Ziel-URL​

Geben Sie die URL Ihres Endpunkts ein. SmartLink sendet die Ereignisse per HTTP POST an diese Adresse.

Geben Sie die URL Ihres Endpunkts ein. SmartLink sendet die Ereignisse per HTTP POST an diese Adresse.

Zu hörende Ereignisse​

Wählen Sie die Ereignisse aus, die Sie empfangen möchten (Benutzererstellung, Anmeldung, ...)

Wählen Sie die Ereignisse aus, die Sie empfangen möchten. Sie können mehrere gleichzeitig auswählen.

API​

Zugriff auf den API-Tab​

Über den Tab API in der Konfigurationsseite können Sie den Zugriff auf die SmartLink REST-API aktivieren.

07.api-tab---disabled

Standardmäßig ist die API deaktiviert.

Der Banner zeigt den aktuellen Status der API an. Hier ist die API deaktiviert.

API aktivieren​

Aktivieren Sie diesen Schalter in der Symbolleiste, um die SmartLink-API zu aktivieren

Aktivieren Sie den Schalter API aktivieren in der Symbolleiste, um den Zugriff auf die API zu aktivieren.

10.api-tab---enabled

Nach Aktivierung der API wird Ihr API-Schlüssel angezeigt.

API-Schlüssel​

Der API-Schlüssel wird standardmäßig maskiert angezeigt. Bewegen Sie die Maus darüber, um ihn anzuzeigen.

Der API-Schlüssel wird standardmäßig maskiert angezeigt. Bewegen Sie die Maus darüber, um ihn anzuzeigen.

Schlüssel kopieren​

Klicken Sie auf Kopieren, um den API-Schlüssel in die Zwischenablage zu kopieren

Klicken Sie auf Kopieren, um den API-Schlüssel in die Zwischenablage zu kopieren und in Ihren Integrationen zu verwenden.

Schlüssel neu generieren​

Klicken Sie auf Neu generieren, um einen neuen API-Schlüssel zu erstellen. Der alte Schlüssel wird sofort ungültig.

Klicken Sie auf Neu generieren, um einen neuen API-Schlüssel zu erstellen. Der alte Schlüssel wird sofort ungültig - vergessen Sie nicht, alle Ihre Integrationen zu aktualisieren.

API-Dokumentation​

Klicken Sie hier, um die interaktive Dokumentation der SmartLink-API (Swagger) zu öffnen

Klicken Sie auf Öffnen Sie die SmartLink-API-Dokumentation, um auf die interaktive Dokumentation (Swagger) zuzugreifen, die alle verfügbaren Endpunkte auflistet.

15.api-documentation-page