API-Dokumentation für die Signaturerstellung

⚡ Schnellstart

Drei Schritte von der Registrierung bis zur ersten Signatur.

🔗 Basis-URL

Alle Antworten sind JSON. Bei Erfolg: { "success": true, "data": {…}, "meta": {…} }; bei Fehler: { "success": false, "error": { "code", "message" } }.

https://onlinesignatures.net/api/v1

🔑 Authentifizierung

Jede Anfrage benötigt ein Bearer-Token im Authorization-Header. Schlüssel erstellen und verwalten Sie auf der API-Seite in Ihrem Konto — der vollständige Schlüssel wird nur einmal angezeigt.

curl https://onlinesignatures.net/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_token"

🎨 Ausgabeformate

Standardmäßig wird die Signatur als transparentes PNG zurückgegeben. Fügen Sie den Parameter format hinzu, um ein anderes Format zu erhalten — das verbraucht kein zusätzliches Kontingent.

Schlüssel = wie viele API-Schlüssel Sie in diesem Tarif erstellen können. Anfragen / Monat ist das Hauptkontingent; Anfragen / Minute ist das Burst-Limit.

🔍 Bildqualität

Standardmäßig wird die Unterschrift in Standardqualität (1×) zurückgegeben. Fügen Sie den Parameter quality hinzu, um ein größeres, schärferes Bild zu erhalten: 2× bedeutet doppelt so viele Pixel, 4× vier Mal so viele. Es wird kein zusätzliches Kontingent verbraucht.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"png",
      "quality":4}'

Dieselbe Unterschrift in anderer Qualität

Um genau dieselbe Unterschrift in einer anderen Qualität zu erhalten, speichern Sie den hash aus der Antwort und fordern Sie sie erneut mit POST /api/v1/signatures/replay an. Jeder Aufruf zählt als eine Anfrage.

curl -X POST https://onlinesignatures.net/api/v1/signatures/replay \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"hash":"eyJpdiI6...",
      "format":"png",
      "quality":4}'

Erzeugen Sie eine brandneue Signatur aus Vor- und Nachname.

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator"}'

curl -X POST https://onlinesignatures.net/api/v1/signatures \
 -H "Authorization: Bearer sk_live_..." \
 -H "Content-Type: application/json" \
 -d '{"first_name":"Signature",
      "last_name":"Generator",
      "format":"pdf"}'

Parameter

{
  "success": true,
  "data": {
    "id": 1842,
    "hash": "eyJpdiI6...",
    "format": "pdf",
    "mime": "application/pdf",
    "signature": "data:application/pdf;
       base64,JVBER..."
  },
  "meta": { "quota": { "remaining":179 } }
}

{
  "success": false,
  "error": {
    "code": "format_not_allowed",
    "message": "The pdf format is
      not available on
      your plan."
  }
}

Eine zuvor erstellte Signatur anhand ihres Hash erneut rendern. Das Format können Sie auch über ?format= festlegen.

curl "https://onlinesignatures.net/api/v1/signatures/{hash}?format=svg" \
  -H "Authorization: Bearer sk_live_your_token"

Gibt Ihren Tarif, die verfügbaren Formate, das Monatslimit, den Verbrauch und den Zeitpunkt des Zurücksetzens zurück.

{
  "success": true,
  "data": {
    "plan": "Business",
    "formats": ["png", "svg", "jpg"],
    "rate_per_minute": 1000,
    "key": { "name": "Production", "masked": "sk_live_a1b2…8f9c" },
    "quota": { "limit": 500, "used": 321, "remaining": 179 }
  }
}

⏱️ Limits und Kontingent

Das Monatskontingent ist das Hauptlimit und hängt von Ihrem Tarif ab (siehe API-Tarife). Zusätzlich schützt ein Limit pro Minute (ebenfalls je Tarif) vor Lastspitzen. Antworten enthalten die Header X-Quota-Limit, X-Quota-Remaining und X-Quota-Reset, damit Sie sich selbst drosseln können. Ein Formatwechsel verbraucht kein zusätzliches Kontingent: eine Generierung = eine Anfrage.

⚠️ Fehlercodes