Für Entwickler

Signieren, versiegeln und prüfen aus Ihrer eigenen Software Beta

Ein Aufruf versiegelt ein PDF. Ein weiterer sendet es zur Signatur. Jede Person kann das Ergebnis unter verify.onwyn.io prüfen. Gebaut für Anbieter von ERP- und Unternehmenssoftware, die das Signieren in ihr eigenes Produkt holen möchten.

API-Schlüssel anfordern Die Aufrufe ansehen Ein Dokument prüfen

Während der Beta vergibt Onwyn jeden API-Schlüssel von Hand. Nennen Sie uns den genauen rechtlichen Namen Ihres Unternehmens: Er steht auf jedem Siegel.

Ihr erstes Siegel in drei Schritten

  1. Einen Schlüssel erhalten

    Bewahren Sie ihn auf Ihrem Server auf, in einer Umgebungsvariable. Niemals in einem Browser oder einer App.

    export ONWYN_API_KEY='onwyn_test_XXXXXXXX'
  2. Ein PDF versiegeln

    Das versiegelte PDF kommt im selben Aufruf zurück. Der Header X-Onwyn-Code enthält seinen Code.

    curl -sS --max-time 120 -D - -o sealed.pdf \
      -H "Authorization: Bearer $ONWYN_API_KEY" \
      -F file=@invoice.pdf -F ref=INV-2026-0001 \
      https://sign.onwyn.io/api/seal
  3. Prüfen

    Die Prüfung ist öffentlich und braucht keinen Schlüssel. Ändern Sie ein Zeichen in der Datei und laden Sie sie erneut hoch: Die Prüfung meldet, dass sie verändert wurde.

    curl -sS https://verify.onwyn.io/api/v1/verify/code/ONW-4K7P-2M9X-QB3T

Sieben Aufrufe

Fünf Aufrufe auf dem Sign-Host, jeder mit Ihrem API-Schlüssel. Zwei auf dem Verify-Host, öffentlich und kostenlos.

AufrufWas er tut
POST /api/sealEin PDF senden. Das versiegelte PDF im selben Aufruf zurückerhalten.
POST /api/signEin PDF und bis zu 10 Unterzeichnende senden. Für jede Person einen Signaturlink erhalten.
GET /api/sign/{id}Sehen, wie weit die Signatur ist, Person für Person.
GET /api/sign/{id}/documentDas fertige PDF herunterladen.
GET /api/sign/{id}/progress-copyMehrere Unterzeichnende: eine Kopie nach der ersten Signatur. Nicht versiegelt, nicht endgültig.
GET /api/v1/verify/code/{code}Einen Code prüfen. Öffentlich, ohne Schlüssel.
POST /api/v1/verify/uploadEine PDF-Datei prüfen. Öffentlich, ohne Schlüssel.

Ein Dokument zur Signatur senden

Die Antwort enthält für jede unterzeichnende Person einen Signaturlink. Sie zeigen den Link in Ihrem Produkt an oder senden ihn selbst. Die Person öffnet ihn im Browser, liest, stimmt zu und signiert, ohne Konto und ohne App. Mit einer Rücksprungadresse kehrt der Browser danach zu Ihrem Produkt zurück.

curl -sS --max-time 120 \
  -H "Authorization: Bearer $ONWYN_API_KEY" \
  -F file=@quotation.pdf -F 'signer_name=Anna Muster' -F ref=SO42 \
  -F return_url=https://erp.example.com/orders/42 \
  https://sign.onwyn.io/api/sign
Mehrere Unterzeichnende.
Bis zu 10, nacheinander oder alle gleichzeitig.
Wo die Signatur steht.
Schreiben Sie {{sign:1}} und {{date:1}} in das PDF, oder senden Sie Seite und Position.
Nur signieren.
Senden Sie seal=false, um die Signaturen ohne das Onwyn-Siegel zu erhalten.
Der Name Ihrer Kundschaft auf dem Siegel.
Sie verkaufen an viele Unternehmen? Senden Sie company_name mit jedem Aufruf, dann nennt das Siegel Ihre Kundin oder Ihren Kunden neben Ihnen.
Auf das Ergebnis warten.
Fragen Sie den Status alle 5 bis 10 Sekunden ab oder sobald die unterzeichnende Person zu Ihrer Rücksprungadresse zurückkehrt. Laden Sie dann das Dokument herunter.
Dasselbe in Python
import os, requests

BASE = "https://sign.onwyn.io"
AUTH = {"Authorization": f"Bearer {os.environ['ONWYN_API_KEY']}"}

with open("quotation.pdf", "rb") as f:
    r = requests.post(f"{BASE}/api/sign", headers=AUTH, timeout=120,
                      files={"file": ("quotation.pdf", f, "application/pdf")},
                      data={"signer_name": "Anna Muster", "ref": "SO42"})
r.raise_for_status()
request = r.json()
print(request["signers"][0]["signing_url"])   # give this link to the signer

status = requests.get(request["status_url"], headers=AUTH, timeout=30).json()
if status["status"] == "completed":
    pdf = requests.get(status["document_url"], headers=AUTH, timeout=60).content

Gut zu wissen, bevor Sie loslegen

  • Über die API sendet Onwyn keine E-Mail. Sie geben jeder unterzeichnenden Person ihren Link, und wer ihn öffnet, kann signieren. Der Nachweis hält das fest.
  • Ein erneut gesendeter Aufruf erzeugt ein neues Dokument. Verwenden Sie ein Zeitlimit von 120 Sekunden. Bei 503 busy warten Sie die Sekunden aus Retry-After ab und versuchen es dann erneut.
  • Diese API hat noch keine Webhooks. Fragen Sie stattdessen den Status ab.
  • Ein PDF darf bis zu 25 MB und 100 Seiten haben. Jede Adresse kann pro Minute 30 Versiegelungen und 30 Signaturanfragen stellen, und bis zu 500 Dokumente pro Tag.
  • Während der Beta bewahrt Onwyn seine Kopie eines Dokuments 30 Tage lang auf. Laden Sie herunter, was Sie brauchen, und bewahren Sie es auf.
  • Jeder Fehler ist JSON mit einem kurzen Code und einem klaren Satz, der sagt, was zu ändern ist.
  • Es ist eine einfache elektronische Signatur, versiegelt mit Onwyns eigenem Zertifikat und eigener Uhr. Was die Beta ist und was nicht.

Mit Ihrem Schlüssel erhalten Sie die vollständige API-Referenz mit Beispielen in curl, Python, PHP und Node, so geschrieben, dass Sie sie einem KI-Programmierassistenten geben können.

Schicken Sie uns Ihre Entwickler

Wir planen die Integration mit Ihrem Team: welche Aufrufe, wo die Signatur steht und wie die Namen Ihrer Kunden auf dem Siegel erscheinen.

Eine Integration mit uns planen

Die API kostet dasselbe wie die Web-App. Zu den Preisen.