Dieser Artikel führt Sie durch den Prozess, ein Dokument mithilfe der Sign.Plus eSignature API zur Unterschrift zu senden.
Mit diesen Schritten erstellen Sie ein Envelope, fügen ein Dokument hinzu, legen einen Empfänger fest, fügen eine Signaturannotation ein und senden schließlich das Envelope zur Unterschrift.
Voraussetzungen
- Ein Sign.Plus-Konto mit einem API-Tarif
- Ihr
Personal Access Token
Schritt 1: Ein Envelope erstellen
Ein Envelope ist ein Container für Dokumente, die von Empfängern unterschrieben werden sollen.
- Senden Sie eine Anfrage an den Endpunkt POST /v2/envelope, um ein neues Envelope zu erstellen.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Fügen Sie Ihren API-Schlüssel im
Authorization-Header ein. -
Bei Erfolg erhalten Sie ein
Envelope-Objekt.{ "id": "<string>" ... } -
Speichern Sie die
idalsenvelope_id
Schritt 2: Dokument zu Ihrem Envelope hinzufügen
-
Verwenden Sie den Endpunkt POST /v2/envelope/{envelope_id}/document, 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/form-data. -
Bei Erfolg erhalten Sie ein
Document-Objekt als Antwort.{ "id": "<string>" ... } -
Speichern Sie die
idalsdocument_idfür später.
Schritt 3: Empfänger für Ihr Envelope festlegen
-
Verwenden Sie den Endpunkt POST /v2/envelope/{envelope_id}/signing_steps, um einen Empfänger hinzuzufügen.
-
Ersetzen Sie
{envelope_id}durch Ihre Envelope-ID. -
Senden Sie eine
POST-Anfrage mit folgendem JSON-Body:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
Bei Erfolg erhalten Sie ein Array von
SigninStep. -
Durchsuchen Sie das Array und notieren Sie sich den
id-Namen des Empfängers, für den Sie den Signaturrahmen (die Signaturannotation) hinzufügen möchten. Speichern Sie dieseidalsrecipient_id.
Schritt 4: Signaturannotation in Ihr Dokument einfügen
Bevor Sie eine Signaturannotation hinzufügen, stellen Sie sicher, dass Sie Ihre Signatur in der Sign.Plus-Plattform definiert haben.
- Verwenden Sie den Endpunkt POST /v2/envelope/{envelope_id}/annotation, um eine Signaturannotation hinzuzufügen.
- Ersetzen Sie
{envelope_id}durch Ihre Envelope-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: Envelope zur Unterschrift senden
- Verwenden Sie den Endpunkt POST /v2/envelope/{envelope_id}/send, um das Envelope zu senden.
- Ersetzen Sie
{envelope_id}durch Ihre Envelope-ID. - Senden Sie eine
POST-Anfrage an diesen Endpunkt. - Bei Erfolg wird das Envelope zur Unterschrift an den Empfänger gesendet.
Fazit
Sie haben jetzt erfolgreich ein Dokument über die Sign.Plus eSignature API zur Unterschrift gesendet. Der Empfänger erhält eine E-Mail-Benachrichtigung mit einem Link zum Unterzeichnen des Dokuments.
Weitere ausführliche Informationen zu jedem in diesem Prozess verwendeten API-Endpunkt finden Sie in unserer API-Dokumentation.