API-Schlüssel und Webhooks

Mit der NextSign-API können Ihre eigenen Systeme Fälle anlegen und senden, und mit Webhooks werden sie benachrichtigt, wenn etwas passiert, etwa wenn ein Fall unterschrieben ist. Dafür brauchen Sie einen API-Schlüssel und eine Adresse, an die der Webhook senden kann.

Das Video zeigt, wie Sie beides anlegen. Unten sind die Schritte beschrieben.

So geht's

1. API-Schlüssel erstellen. Klicken Sie unter API-Schlüssel auf „Erstellen“ und benennen Sie den Schlüssel, zum Beispiel nach dem System, das ihn nutzen soll.
2. Schlüssel sichern. Der Schlüssel wird nur einmal angezeigt. Kopieren Sie ihn und bewahren Sie ihn sicher auf, zum Beispiel in den Secrets Ihres Systems.
3. Webhook erstellen. Klicken Sie unter Webhooks auf „Erstellen“. Benennen Sie den Webhook, wählen Sie die Ereignisse, die eine Nachricht auslösen, und geben Sie die Zieladresse an.
4. Webhook testen. Wählen Sie im Menü neben dem Webhook „Test senden“, wählen Sie ein Ereignis und einen Fall und senden Sie den Test. Sie sehen sofort, ob die Nachricht zugestellt wurde.

Gut zu wissen

• Legen Sie pro System einen Schlüssel an, dann können Sie einen Schlüssel löschen, ohne die anderen zu berühren.
• Unter Läufe anzeigen sehen Sie die letzten Nachrichten des Webhooks und ob sie zugestellt wurden.
• Muss Ihr System den Absender kennen, finden Sie die IP-Adresse von NextSign für die Freigabeliste auf der Seite Webhooks.

Fragen und Antworten

Was tun, wenn ein Schlüssel versehentlich geteilt wurde?

Löschen Sie den Schlüssel unter API-Schlüssel und legen Sie einen neuen an. Der alte funktioniert dann nicht mehr.

Über welche Ereignisse kann ein Webhook benachrichtigen?

Unter anderem wenn ein Fall angelegt wird, ein Empfänger unterschrieben hat, alle unterschrieben haben, ein Fall abgelehnt wird oder eine Zustellung fehlgeschlagen ist.

Wo finde ich die API-Dokumentation?

Unter API-Dokumentation im Menü unten links.