Erste Schritte mit der Sign.Plus API

Die Sign.Plus API ermöglicht Entwicklern, sichere, rechtsgültige E-Signaturen nahtlos in ihre Anwendungen und Websites zu integrieren. Diese Integration schafft ein reibungsloses Signaturerlebnis für Benutzer innerhalb ihrer Plattform.

Folgen Sie dieser Anleitung, um mit der Sign.Plus API zu beginnen:

Konto erstellen und auf einen API-Tarif upgraden

Um mit der Nutzung der Sign.Plus API zu beginnen, müssen Sie ein Konto erstellen und auf einen API-Tarif upgraden:

1. Besuchen Sie https://www.sign.plus/api/pricing.

2. Wählen Sie den Tarif, der Ihren Anforderungen entspricht, und erstellen Sie ein Konto.

Personal Access Token generieren

Nach dem Upgrade müssen Sie ein Personal Access Token erstellen, um mit der Sign.Plus API zu interagieren:

1. Suchen Sie im API-Bereich die Option zum Erstellen eines neuen Personal Access Tokens.

2. Wählen Sie die Berechtigungsbereiche für Ihr Token:
   sign:all:read: Gewährt Zugriff zum Lesen von Ressourcen (über GET-Endpunkte)
   sign:all:edit: Ermöglicht das Bearbeiten von Ressourcen (über POST-, PUT- und DELETE-Endpunkte)

   Tipp: Sie können beide Bereiche oder nur einen auswählen, je nach Ihren Anforderungen

3. Legen Sie ein Ablaufdatum für Ihr Token fest.

   Tipp: Wir empfehlen eine Gültigkeitsdauer von 90 Tagen.

4. Generieren Sie Ihr Token und speichern Sie es sicher. Nach diesem Schritt können Sie es nicht mehr erneut einsehen.
   

   Hinweis: Richten Sie Erinnerungen für die Erneuerung und Rotation des Tokens ein, um eine strikte API-Zugriffssicherheit zu gewährleisten.

Testen Sie Ihre API-Verbindung

Sobald Sie Ihr Personal Access Token haben, ist es Zeit, sicherzustellen, dass alles korrekt funktioniert. Sie haben mehrere Möglichkeiten, mit unserer API zu interagieren:

1. cURL
   Öffnen Sie Ihr Terminal und führen Sie den folgenden Befehl aus:

   curl -I --location '<https://restapi.sign.plus/v2/envelopes>' \\
   --header 'Content-Type: application/json' \\
   --header 'Authorization: $PERSONAL_ACCESS_TOKEN' \\
   --data '{}'

   Ersetzen Sie $PERSONAL_ACCESS_TOKEN durch das zuvor generierte Token.

   Wenn Sie einen 200 OK-Statuscode erhalten, herzlichen Glückwunsch! Ihre API-Verbindung funktioniert einwandfrei.
   
2. Postman
   

   • Öffnen Sie Postman und erstellen Sie eine neue Anfrage.

   • Setzen Sie den Anfragetyp auf POST und geben Sie die API-Endpunkt-URL ein

     https://restapi.sign.plus/v2/envelopes
   • Fügen Sie im Tab „Headers" einen neuen Header hinzu:
   • Schlüssel: Authorization
   • Wert: Bearer $PERSONAL_ACCESS_TOKEN

   • Senden Sie die Anfrage und prüfen Sie, ob ein 200 OK-Statuscode als Antwort zurückkommt. Herzlichen Glückwunsch! Sie sind jetzt bereit, die Sign.Plus-eSignature-API in Ihren Projekten zu verwenden.

Hier sind einige nächste Schritte und zusätzliche Ressourcen, die Ihnen helfen, unsere API optimal zu nutzen:

API-Dokumentation

Für detaillierte Informationen zu API-Endpunkten und erweiterten Funktionen lesen Sie bitte unsere umfassende API-Dokumentation.

Backend-SDKs

Wir empfehlen dringend, unsere Backend-SDKs (Installation - Sign.Plus API ) zu verwenden, um die Sign.Plus-eSignature-API nahtlos in Ihr Backend zu integrieren. Wir bieten SDKs für folgende Sprachen an:

• Python
• TypeScript
• Go
• Java
• C#
• PHP
   

Die Verwendung dieser SDKs kann Ihren Integrationsprozess erheblich vereinfachen und Ihnen helfen, schnell einsatzbereit zu sein.