Erstellungsansicht für den Envelope-Versand

POST /esignglobal/v1/envelopes/views/sender

Schnittstellenbeschreibung

Erstellt eine Absendersicht für einen Umschlag anhand der Umschlag-ID. Entwickler können die über diese Schnittstelle abgerufene Seite verwenden, um die Sendevorschau in ihre Drittanbieteranwendung zu integrieren.

Der über diese Ansicht initiierte Signaturprozess wird mit den Benutzerinformationen gefüllt, die aus dem Access Token in OAuth extrahiert werden.
Vor dem Aufruf dieser Schnittstelle muss zuerst ein Umschlag im Entwurfsstatus über die Schnittstelle zum Erstellen eines Signaturprozesses erstellt werden.
Nachdem die Signaturprozess-ID erstellt wurde, kann der Umschlag über Schnittstellen wie das Hinzufügen von Signaturdateien und das Hinzufügen von Unterzeichnern eingerichtet werden.
Die von dieser Ansicht generierte Startseite unterstützt die Einbettung in iframes und Webviews. Die Seitensprache ist standardmäßig Englisch.
Der Aufruf dieser Schnittstelle unterstützt keine Signaturprozesse, die eine stille Signatur des Unterzeichners beinhalten.

Anfrageparameter

Parametername		Typ	Ist erforderlich	Beschreibung
envelopeId		string	true	Signaturprozess-ID. Es dürfen nur Signaturprozess-IDs im Status 0 - Erstellt (Entwurf) übergeben werden.
returnUrl		string	true	Weiterleitungsadresse (Länge 2048) nach Abschluss des Signaturprozesses. Muss eine https-/http-Protokolladresse sein.
settings		object	false	Benutzerdefinierte Einstellungen für die Sende-Seite
	startingPage	string	false	Startseite der Ansicht senden, standardmäßig preparePage. preparePage - Seite für die Einrichtung grundlegender Informationen taggingPage - Seite für die Einrichtung von Signatur-Steuerelementen
	submitAction	string	false	Senden, standardmäßig send save - Speichern, die Seite zeigt die Schaltfläche zum Speichern an und blendet die zugehörigen Schaltflächen zum Senden aus; send - Senden, die Seite zeigt die Schaltflächen "Jetzt senden", "Senden", "Später senden" an und blendet die Schaltfläche zum Speichern aus;
	showBackButton	boolean	false	Ob die Schaltfläche "Zurück" auf der Tagging-Seite angezeigt werden soll, standardmäßig true. true - Anzeigen false - Nicht anzeigen
	lockedArea	array	false	Informationen, die in der Absenderansicht nicht geändert werden dürfen, standardmäßig leer. Aufzählungswerte umfassen: document - Signaturdokument signerInfo - Informationen zum Unterzeichner

Beispielanfrage

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

Antwortparameter

Parametername	Typ	Beschreibung
url	string	Adresse der Seite zum Starten des Umschlags

Beispielantwort

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}