Entwickler · API · Webhooks

Ein Aufruf verschickt den Vertrag.Sie wissen sofort, wenn er unterschrieben ist.

Eine REST-API, mit der Sie PDFs zur Unterschrift senden und jeden Unterzeichner verfolgen, signierte Webhooks für jeden Schritt, Idempotenzschlüssel und stabile Fehlercodes. Ein API-Schlüssel und Webhooks in jedem Tarif: Free 10 Dokumente pro Monat, Branded 100 über die API, Enterprise ohne Grenze.

Was Sie bauen können: Unterschriften aus Ihrer eigenen Software

Erster Aufruf: den Schlüssel prüfen. Er sendet nichts.

# Paste the full key — the dashboard only shows its prefix
export WESIGN_API_KEY="wsk_live_…"

# Sends nothing: checks the key and names its workspace
curl https://api.wesign.now/v1/me \
  -H "Authorization: Bearer $WESIGN_API_KEY"
# 200 → { "workspace": { … }, "key": { … }, "capabilities": { … }, … }

Dann ein PDF an zwei Unterzeichnende senden.

# Paste the full key — the dashboard only shows its prefix
export WESIGN_API_KEY="wsk_live_…"

curl -X POST https://api.wesign.now/v1/signing-requests \
  -H "Authorization: Bearer $WESIGN_API_KEY" \
  -H "Idempotency-Key: quickstart-$(date +%s)" \
  -F "file=@contract.pdf" \
  -F "placement=auto_append" \
  -F 'signers=[
        { "email": "anna.muster@example.com",
          "name": "Anna Muster", "role": "counterparty" },
        { "email": "you@example.com",
          "name": "Your name", "role": "company" }
      ]'
# 201 → { "documentId": "…", "signers": [
#   { "role": "counterparty", "signingUrl": "…", "emailed": true },
#   { "role": "company",      "signingUrl": "…", "emailed": true } ] }
# Every answer carries an X-Request-Id header: quote it to
# support@wesign.now when something is off.
Ein API-Schlüssel in jedem Tarif

So erhalten Sie Ihren API-Schlüssel

  • Free: 10 Dokumente pro Monat, die Grenze des Tarifs
  • Branded: 100 Dokumente pro Monat über die API
  • Enterprise: ohne Grenze
  1. 1. Kostenlos registrieren.
  2. 2. Öffnen Sie Einstellungen → API und schalten Sie Entwicklereinstellungen ein.
  3. 3. Einstellungen → API → Schlüssel erstellen.
  4. 4. Rufen Sie GET /v1/me mit dem Schlüssel auf. Der Aufruf sendet nichts und zeigt, dass der Schlüssel funktioniert.
Was Sie bekommen

Eine API, Webhooks und eine Doku, die auch Ihre Tools lesen.

REST-API

PDF senden, jeden Unterzeichner verfolgen, erinnern oder zurückziehen, das versiegelte PDF und seinen Audit-Trail herunterladen. Bearer-Schlüssel, JSON-Antworten und eine OpenAPI-3.1-Spezifikation mit einer ID für jede Operation.

API-Überblick

Signierte Webhooks

signing_request.sent, .viewed, .signed, document.completed und weitere, jedes mit HMAC-SHA256 signiert. Eine fehlgeschlagene Zustellung wiederholen wir rund 45 Stunden lang; im Zustellprotokoll können Sie sie erneut senden.

Webhook-Events

Doku für KI-Assistenten

llms.txt listet jede Doku-Seite auf, llms-full.txt enthält sie alle als reinen Text, openapi.json die genauen Formen von Anfragen und Antworten. Geben Sie sie Ihrem Coding-Assistenten.

Für KI-AssistentenMCP-Server: aus Ihrem Agenten senden und verfolgenSie arbeiten mit einem Agenten? So verbinden Sie ihn

Konkrete Beispiele.

Vier Aufrufe, die die meisten Integrationen brauchen. Feldnamen wie in der OpenAPI-Spezifikation.

1. Senden mit Anker-Platzierung

Setzen Sie einen Marker wie [[ls:signature:buyer]] in Ihr PDF. Wir platzieren dort das Signaturfeld des Käufers und blenden den Marker aus. Kein Marker im PDF? Dann hängen wir eine Signaturseite an.

# offer.pdf contains the text [[ls:signature:buyer]]
curl https://api.wesign.now/v1/signing-requests \
  -H "Authorization: Bearer $WESIGN_API_KEY" \
  -H "Idempotency-Key: offer-2041/sign" \
  -F "file=@offer.pdf" \
  -F "placement=anchors" \
  -F 'signers=[{"email":"buyer@acme.com","role":"buyer","name":"Ann Buyer"}]'

2. Mehrere Unterzeichnende, der Reihe nach

Drei Unterzeichnende, nacheinander. Unterzeichner 2 wird erst eingeladen, wenn Unterzeichner 1 unterschrieben hat.

curl https://api.wesign.now/v1/signing-requests \
  -H "Authorization: Bearer $WESIGN_API_KEY" \
  -H "Idempotency-Key: round-a/sign" \
  -F "file=@contract.pdf" \
  -F "signing_mode=sequential" \
  -F "placement=auto_append" \
  -F 'signers=[
    {"email":"founder@acme.com","role":"founder"},
    {"email":"investor@vc.example","role":"investor"},
    {"email":"witness@law.example","role":"witness"}
  ]'

3. Webhook-Empfänger

Prüfen Sie den Zeitstempel und den HMAC über den unveränderten Body, dann reagieren Sie auf das Event.

// Node + Express. The full verifier (Node and PHP) is in the docs.
app.post('/wesign/callback', express.raw({ type: 'application/json' }), (req, res) => {
  // X-WeSign-Signature: t=<unix seconds>,v1=<hex>  (two v1 for 24 h after a rotation)
  const parts = (req.get('x-wesign-signature') ?? '').split(',')
  const t = parts[0]?.startsWith('t=') ? parts[0].slice(2) : ''
  if (!t || Math.abs(Date.now() / 1000 - Number(t)) > 300) return res.status(401).end()
  const expected = crypto.createHmac('sha256', SECRET)
    .update(`${t}.${req.body}`).digest()
  const valid = parts.filter((p) => p.startsWith('v1=')).some((p) => {
    const got = Buffer.from(p.slice(3), 'hex')
    return got.length === expected.length && crypto.timingSafeEqual(got, expected)
  })
  if (!valid) return res.status(401).end()

  const evt = JSON.parse(req.body.toString('utf8'))
  if (evt.event === 'document.completed') {
    // fetch evt.signed_pdf_url with your API key, compare evt.sha256, keep a copy
  }
  res.sendStatus(200)
})

4. Idempotente Wiederholung

Derselbe Schlüssel mit demselben Body innerhalb von 24 Stunden liefert die erste Antwort erneut. Eine Wiederholung nach einem Netzwerkfehler sendet also nie doppelt.

POST /v1/signing-requests
Idempotency-Key: order-123/sign

# First call:                      201 Created
# Same key + same body (24 h):     201, the same body, Idempotent-Replayed: true
# Same key while the first runs:   409 idempotency_in_progress + Retry-After
# Same key + a different body:     422 idempotency_key_reuse
Rezepte

Was Sie heute bauen können.

Jedes Muster nutzt die REST-API und Webhooks. Die Karten verlinken auf die Doku, die es beschreibt.

Noch nicht verfügbar: ein SDK, eine Sandbox mit Testschlüsseln (geplant für den 30. November) sowie Apps oder Plug-ins für andere Tools.

Gebaut für den Produktivbetrieb.

Bearer-Schlüssel, zwei Scopes

Jeder Schlüssel gehört zu genau einem Workspace. Ein full-Schlüssel ruft die ganze API auf, ein embedded-Schlüssel verwaltet nur eingebettete Signatursitzungen. Beschränken Sie einen Schlüssel auf Ihre IP-Adressen; ein Widerruf wirkt sofort.

60 Anfragen pro Minute und Schlüssel

Ein festes Zeitfenster pro Schlüssel über alle /v1-Endpunkte. Erfolgreiche Antworten tragen RateLimit-*-Header, ein 429 trägt Retry-After.

Stabile Fehlercodes

Jeder Fehler ist JSON mit einer lesbaren Meldung (error), einem stabilen code und, wo es hilft, meta. Prüfen Sie den code; die Meldung kann sich ändern.

Versiegelte, prüfbare PDFs

Das unterschriebene PDF trägt ein PAdES-Siegel, das jeder konforme Reader prüfen kann. Der Audit-Trail listet jedes Ereignis mit Zeitpunkt, E-Mail-Adresse und maskierter IP-Adresse des Unterzeichners sowie jede SMS-Code-Prüfung.

Holen Sie sich Ihren API-Schlüssel und versenden Sie heute Ihren ersten Vertrag.

Registrieren Sie sich kostenlos, schalten Sie die Developer-Einstellungen ein und erstellen Sie einen Schlüssel. Enterprise bringt unbegrenzte API-Dokumente, eingebettetes Unterschreiben und Vorlagenversand über die API: Sprechen Sie mit uns. Die Doku ist öffentlich, Sie können sie also vorher lesen.