Wie lege ich einen API-Schlüssel oder Webhook an?
Einstellungen › API und Integrationen: „Schlüssel“ anlegen (wird nur einmal angezeigt), Webhooks für Admins. API-Doku unter /docs.
Mit der REST-API verbinden Sie Agile eSign mit Ihrem CRM, Ihrer Branchensoftware oder Automationen. Die Doku finden Sie unter https://esign.agiledeveloper.de/docs.
API-Schlüssel anlegen
- Öffnen Sie Einstellungen › API und Integrationen und klicken Sie auf Schlüssel.
- Vergeben Sie einen Name (z. B. „CRM-Anbindung“), wählen Sie die Rechte (etwa Umschläge lesen, Umschläge anlegen und versenden, Vorlagen lesen) und optional Läuft ab am.
- Der Schlüssel beginnt mit
agile_sign_und wird nur jetzt angezeigt. Speichern Sie ihn sicher, zum Beispiel im Passwortmanager, und bestätigen Sie mit Ich habe ihn gespeichert.
Sie können nur Rechte vergeben, die Sie selbst im Team haben. Senden Sie den Schlüssel im Kopf Authorization: Bearer agile_sign_…. Nicht mehr benötigte Schlüssel widerrufen Sie in derselben Liste.
Webhooks
Webhooks melden Ereignisse wie „Umschlag abgeschlossen“ sofort an Ihr System. Inhaber und Admins legen sie im selben Abschnitt mit Adresse (https) und den gewünschten Ereignissen an. Jede Zustellung ist mit HMAC-SHA256 signiert (Kopf Agile-Signature); das Geheimnis zum Prüfen wird nur beim Anlegen angezeigt. Mit Test senden probieren Sie es aus, das Zustellprotokoll zeigt jede Zustellung.
Antwortet Ihr System nicht mit einem 2xx-Status, versucht Agile eSign es erneut: höchstens 8 Versuche, der Abstand verdoppelt sich von 1 Minute bis etwa 1 Stunde. Nach rund 2 Stunden gilt die Zustellung als fehlgeschlagen und steht so im Zustellprotokoll. Ist Ihr System länger nicht erreichbar, gleichen Sie verpasste Ereignisse über die API ab.
Für KI-Assistenten wie Claude oder ChatGPT brauchen Sie keinen Schlüssel: Dafür gibt es die Anmeldung per MCP.