Entwickler-API · Aktualisiert
Unterschriften direkt in Ihr eigenes Produkt holen.
Erstellen Sie Dokumente aus einem PDF, einer Word-Datei oder einer Vorlage, senden Sie sie zur Unterschrift, verfolgen Sie den Status und erhalten Sie Webhooks, wenn unterschrieben wurde, alles aus Ihrem Code.
REST API
Webhooks
API-Schlüssel
Ist die eSignSimple API verfügbar?
Ihre eigene Software kann jetzt Dokumente erstellen, zur Unterschrift senden, ihren Status verfolgen und unterschriebene Kopien herunterladen, ohne dass sich jemand im Dashboard anmeldet. Die REST API liegt unter https://esignsimple.com/api/v1, die vollständige Referenz mit Anfrage- und Antwortbeispielen finden Sie auf unserer Entwicklerseite.
Unterzeichner, die über die API erreicht werden, erhalten genau dasselbe Unterschreiben ohne Konto und dieselben Nachweise wie bei Dokumenten aus dem Dashboard: einen Audit-Trail, ein Abschlusszertifikat und einen SHA-256-Hash, den jeder auf unserer öffentlichen Prüfseite kontrollieren kann.
Wie funktioniert die API?
Erstellen Sie ein Dokument mit POST /documents. Sie senden eine Multipart-Anfrage mit dem PDF und einem JSON-Teil, der Unterzeichner und Felder auflistet. Feldpositionen werden als Bruchteile der Seite angegeben, Sie müssen sich also nicht um PDF-Punkte oder Seitengrößen kümmern. Das Dokument wird sofort gesendet oder als Entwurf gespeichert, wenn Sie send:false übergeben.
Sie haben schon eine Vorlage im Dashboard? POST /templates/{id}/send trägt die Unterzeichner ein und sendet sie. GET /documents listet Ihre Dokumente mit Statusfilter und Cursor-Paginierung über before. GET /documents/{id} liefert Status, Unterzeichner und den vollständigen Audit-Trail, und GET /documents/{id}/download liefert das unterschriebene PDF, sobald das Dokument abgeschlossen ist, oder mit ?file=original das Original.
Außerdem können Sie ein laufendes Dokument mit POST /documents/{id}/void stornieren, eines mit DELETE /documents/{id} löschen und mit GET /me Ihren Tarif und Ihre aktuelle Nutzung abfragen.
Wie funktionieren Authentifizierung und API-Schlüssel?
Jede Anfrage nutzt einen Bearer-API-Schlüssel. Schlüssel erstellen und widerrufen Sie unter Einstellungen → Entwickler. Ein Schlüssel wird beim Erstellen einmal angezeigt, und wir speichern nur einen Hash, kopieren Sie ihn also sofort in Ihren Secret Manager. Gelangt ein Schlüssel nach außen, widerrufen Sie ihn und erstellen einen neuen; sonst muss sich nichts ändern.
Dieselbe API akzeptiert auch Firebase-ID-Tokens, die unsere kommende mobile App nutzen wird. Das ist eine bewusste Entscheidung: Wir bauen unsere eigenen Apps auf derselben öffentlichen API, die Sie nutzen, sodass sie jeden Tag im Einsatz ist.
Welche Webhooks können Sie empfangen?
Statt regelmäßig abzufragen, registrieren Sie einen HTTPS-Endpunkt für Ihr Konto, und wir benachrichtigen ihn, wenn etwas passiert. Die Ereignisse sind document.completed, document.declined, document.voided und signer.signed.
Jede Zustellung ist mit HMAC-SHA256 signiert, und die Signatur steht im Header esign-signature, damit Sie prüfen können, ob die Anfrage wirklich von uns kommt, bevor Sie darauf reagieren. Schlägt Ihr Endpunkt fehl, versuchen wir es einmal erneut. Unser Rat: Behandeln Sie Webhooks als Auslöser und rufen Sie GET /documents/{id} für den maßgeblichen Stand auf.
Was bauen Leute mit der API?
Ein CRM oder Angebotstool, das einen Vertrag verschickt, sobald ein Deal als gewonnen markiert ist. Ein HR-System, das aus einer Vorlage ein Onboarding-Paket sendet, wenn eine Einstellung bestätigt ist. Ein Immobilien-Tool, das einen Mietvertrag sendet und das unterschriebene PDF bei der Wohnung ablegt, sobald document.completed eintrifft. Ein internes Skript, das verhindert, dass jemand Zeilen aus einer Tabelle von Hand in Verträge kopiert.
Wenn Sie nur eine Handvoll Dokumente pro Woche verschicken, brauchen Sie die API wahrscheinlich gar nicht. Vorlagen, Massenversand und Webformulare im Dashboard decken das mit viel weniger Aufwand ab.
Was kostet die API?
Es gibt keinen eigenen API-Tarif. Es gelten dieselben Tariflimits wie in der Web-App: Der Free-Tarif enthält 5 Dokumente pro Monat, Personal ist unbegrenzt (siehe Preise). Über die API erstellte Dokumente zählen genauso wie Dokumente aus dem Dashboard.
Große Anbieter wie DocuSign, Dropbox Sign und Adobe berechnen ihre APIs meist getrennt von den Nutzertarifen, oft auf Basis jährlicher Umschlagvolumen, und Einstiegs-API-Tarife können deutlich mehr kosten als ihre Standardabos. Aktuelle Preise finden Sie auf deren Websites.
Was ist noch nicht enthalten?
Wir sind ehrlich, was die Lücken angeht. Es gibt noch kein Iframe für eingebettetes Unterschreiben, Unterzeichner unterschreiben also weiterhin über den Link, den wir ihnen per E-Mail schicken. Es gibt keine offiziellen SDKs; die API ist reines HTTP und JSON, jede Sprache mit HTTP-Client funktioniert also. Es gibt keine separate Sandbox-Umgebung, testen Sie daher mit einem kostenlosen Konto und Ihren eigenen E-Mail-Adressen. All das steht auf unserer Roadmap.
Warum haben wir mit einer kleinen API angefangen?
Wir haben bewusst schmal begonnen. Eine kleine API, die den gängigen Ablauf gut erledigt, mit vorhersehbaren Limits und ohne Verkaufsgespräch, ist nützlicher als eine riesige Oberfläche, deren Integration Wochen dauert. Fehlt Ihnen etwas, sagen Sie uns, was Sie bauen; echte Integrationen entscheiden, was wir als Nächstes ergänzen.
Welche API-Endpunkte gibt es heute?
| Endpunkt | Was er tut | Typischer Einsatz |
|---|---|---|
| POST /documents | PDF mit Unterzeichnern und Feldern hochladen, senden oder als Entwurf speichern | Einen generierten Vertrag aus Ihrer App senden |
| POST /templates/{id}/send | Eine Dashboard-Vorlage an benannte Unterzeichner senden | Onboarding-Paket bei bestätigter Einstellung |
| GET /documents, GET /documents/{id} | Dokumente auflisten oder Status, Unterzeichner und Audit-Trail abrufen | Status in ein CRM synchronisieren |
| GET /documents/{id}/download | Das unterschriebene PDF (oder das Original) herunterladen | Die unterschriebene Kopie beim Datensatz ablegen |
| POST /documents/{id}/void und DELETE /documents/{id} | Ein Dokument stornieren oder löschen | Ein Angebot zurückziehen oder Entwürfe aufräumen |
| GET /me | Tarif und Nutzung im laufenden Monat | Warnen, bevor das Free-Limit erreicht ist |
Häufige Fragen
Hat eSignSimple eine API?
Ja. Die REST API ist unter https://esignsimple.com/api/v1 verfügbar, mit Bearer-API-Schlüsseln und Webhooks. Die Referenz finden Sie auf unserer Entwicklerseite.
Was kostet die API?
Es gibt keine separaten API-Preise. Es gilt Ihr normaler Tarif: Free enthält 5 Dokumente pro Monat, Personal ist unbegrenzt.
Wie bekomme ich einen API-Schlüssel?
Erstellen Sie einen unter Einstellungen → Entwickler. Er wird einmal angezeigt und gehasht gespeichert, sichern Sie ihn also sofort. Sie können Schlüssel jederzeit widerrufen.
Welche Webhook-Ereignisse gibt es?
document.completed, document.declined, document.voided und signer.signed, signiert mit HMAC-SHA256 im Header esign-signature, mit einem erneuten Zustellversuch.
Unterstützen Sie eingebettetes Unterschreiben, SDKs oder eine Sandbox?
Noch nicht. Alle drei stehen auf unserer Roadmap. Heute unterschreiben Unterzeichner über einen per E-Mail geschickten Link, und Sie rufen die API über reines HTTP auf.
Lassen Sie Ihr nächstes Dokument noch heute unterschreiben.
Starten Sie mit 5 kostenlosen Dokumenten pro Monat. Keine Kreditkarte nötig.