Dieser Artikel führt Sie durch den Prozess des Versands eines Dokuments zur Unterschrift mit der eSignature API.
Nach diesen Schritten erstellen Sie einen Umschlag, fügen ein Dokument hinzu, setzen einen Empfänger ein, fügen eine Signaturnotiz ein und senden schließlich den Umschlag für die Unterschrift.
Voraussetzungen
- Ein Sign.Plus-Konto mit einem API-Plan
- Ihr
Persönliches Zugangs-Token
Schritt 1: Einen Umschlag erstellen
Ein Umschlag ist ein Container für Dokumente, die von den Empfängern unterzeichnet werden müssen.
- Senden Sie eine Anfrage an den Endpunkt POST /v2/envelope um einen neuen Umschlag zu erstellen.
{
"name": "Mein wunderbarer Umschlag",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Fügen Sie Ihren API-Schlüssel in den
Autorisierungs-
Header ein. -
Bei Erfolg erhalten Sie ein
Umschlag
Objekt.{ "id": "<string>" ... }
-
id
alsUmschlag_id
speichern
Schritt 2: Füge ein Dokument zu deinem Umschlag hinzu
-
Verwenden Sie den POST /v2/envelope/{envelope_id}/document Endpunkt, um ein Dokument hinzuzufügen.
-
Ersetzen Sie
{envelope_id}
durch die ID, die Sie in Schritt 1 erhalten haben. - Senden Sie eine POST-Anfrage mit der Dokumentdatei im Anfragetext als
Multipart/Formulardaten.
-
Bei Erfolg erhalten Sie ein
Dokument
Objekt als Antwort.{ "id": "<string>" ... }
-
Speichern Sie die
id
alsdocument_id
für später.
Schritt 3: Setze einen Empfänger für deinen Umschlag
-
Verwenden Sie den POST /v2/envelope/{envelope_id}/signing_steps Endpunkt, um einen Empfänger hinzuzufügen.
-
Ersetzen Sie
{envelope_id}
durch Ihre Umschlag-ID. -
Senden Sie eine
POST
Anfrage mit folgendem JSON Körper:{
"signing_steps": [
{
"Empfänger": [
{
"name": "John Doe", "email": "john. oe@Beispiel. om", "Rolle": "SIGNER"
} ] } ] } -
Bei Erfolg erhalten Sie ein Array von
SigninStep
. -
Durchsuchen Sie das Array und nehmen Sie die
id
Name des Empfängers, für den Sie den Signaturrahmen hinzufügen möchten (Signatur-Anmerkung). Speichern Sie dieseid
alsrecipient_id
.
Schritt 4: Fügen Sie eine Signaturnotiz in Ihr Dokument ein
Bevor Sie eine Signaturnotiz hinzufügen, stellen Sie sicher, dass Sie Ihre Signatur in der Sign.Plus Plattform definiert haben.
- Verwenden Sie den POST /v2/envelope/{envelope_id}/annotation Endpunkt, um eine Signaturnotiz hinzuzufügen.
- Ersetzen Sie
{envelope_id}
durch Ihre Umschlag-ID. - Senden Sie eine
POST
Anfrage mit folgendem JSON body:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Ersetzen Sie
<recipient_id>
und<document_id>
durch die entsprechenden Werte.
Schritt 5: Sende deinen Umschlag für die Unterschrift
- Benutzen Sie den POST /v2/envelope/{envelope_id}/senden Endpunkt, um den Umschlag zu senden.
- Ersetzen Sie
{envelope_id}
durch Ihre Umschlag-ID. - Senden Sie eine
POST
Anfrage an diesen Endpunkt. - Bei Erfolg wird der Umschlag zur Unterschrift an den Empfänger gesendet.
Schlussfolgerung
Sie haben nun erfolgreich ein Dokument zur Unterschrift mit der Sign.Plus eSignature API gesendet. Der Empfänger erhält eine E-Mail-Benachrichtigung mit einem Link zum Unterschreiben des Dokuments.
Für genauere Informationen zu jedem API-Endpunkt, der in diesem Prozess verwendet wird, lesen Sie bitte unsere -API-Dokumentation.