Zum Inhalt springen

API und Webhooks für Ihre Vertragsdaten

Mit der REST-API legen Sie Verträge aus anderen Systemen an und fragen sie ab. Webhooks melden Ihren Systemen, sobald im Arbeitsbereich etwas passiert.

14 Tage kostenlos, ohne Zahlungsdaten.

Was Sie damit tun

Tokens mit klaren Rechten

Tokens gibt es mit "Nur lesen" oder "Lesen und schreiben" und mit Ablauf nach 30 Tagen, 90 Tagen, einem Jahr oder ohne Ablauf.

Dokumente anlegen und abfragen

Dokumente aus Vorlagen erstellen, suchen, lesen und ändern, samt Parteien, Unterzeichnern, Feldern, Terminen, Datenfeldern und Dateien.

Webhooks für Ereignisse

Klausar meldet zum Beispiel neue Dokumente, Phasenwechsel, Freigaben, Unterschriften und nahende Fristen an eine Adresse Ihrer Wahl.

Im Einzelnen

Dokumente
GET und POST /api/v1/documents, GET und PATCH /api/v1/documents/{id}, POST /api/v1/documents/{id}/stage, GET /api/v1/documents/{id}/pdf.
Parteien und Unterzeichner
GET und POST .../parties, PATCH und DELETE .../parties/{partyId}, POST .../parties/{partyId}/signatories, DELETE .../signatories/{signatoryId}.
Felder, Termine, Daten
GET und PATCH .../fields (nur im Entwurf oder in der Prüfung), .../dates und .../metadata.
Dateien und Fassungen
GET und POST .../files (bis 30 MB), GET .../files/{fileId}, GET .../revisions und .../revisions/{revisionId}/pdf.
Vorlagen, Tags, Teams
GET /api/v1/templates, /api/v1/templates/{id}, /api/v1/tags und /api/v1/teams.
Offene Beschreibung
Die OpenAPI-Beschreibung unter /api/v1/openapi.json ist ohne Token abrufbar.
Webhooks mit Signatur
Jede Zustellung trägt eine HMAC-SHA256-Signatur im Kopf X-Klausar-Signature. Klausar versucht die Zustellung bis zu viermal.
Ab Team, mit Limit
API und Webhooks sind ab dem Paket Team enthalten. Standardmäßig gelten 120 Anfragen je Minute und Token.

So geht es in Klausar

  1. § 01

    Token erstellen

    Inhaber oder Admins öffnen Einstellungen, API und Webhooks und klicken auf "Token erstellen".

  2. § 02

    Anfragen senden

    Senden Sie das Token im Header "Authorization: Bearer <Token>". Klausar speichert nur einen Fingerabdruck, nicht das Token selbst.

  3. § 03

    Webhook anlegen

    Unter Webhooks legen Sie mit "Webhook anlegen" eine Zieladresse und die gewünschten Ereignisse fest.

Häufige Fragen

Nein. Klausar bietet eine REST-API und Webhooks, über die Sie oder Ihr Dienstleister eigene Anbindungen bauen.

Unter anderem Dokument erstellt, Phase geändert, Freigaben, Unterschrift angefordert, eine Partei oder alle haben unterschrieben, Unterschrift abgelehnt, Frist rückt näher sowie abgeschlossene Importe und Automationen.

Ja. Ein Token mit "Nur lesen" darf nur abfragen; Änderungen lehnt die API ab.

Die OpenAPI-Beschreibung steht unter /api/v1/openapi.json Ihres Klausar-Zugangs und ist ohne Token abrufbar.

Holen Sie Ihre Verträge aus Ordnern und Postfächern.

Laden Sie Ihre Verträge hoch. Der Assistent findet die Stichtage, Sie behalten sie im Blick.

14 Tage kostenlos, ohne Zahlungsdaten.