Centre de développement

Créer une vue d'envoi d'enveloppe

POST /esignglobal/v1/envelopes/views/sender

Description de l'interface

Crée une vue d'expéditeur d'enveloppe via l'ID de l'enveloppe. Les développeurs peuvent intégrer la vue d'envoi dans leur propre application tierce via la page obtenue via cette interface.

  1. Le processus de signature lancé via la page de lancement de signature obtenue via cette vue est rempli avec les informations utilisateur analysées à partir du jeton d'accès dans OAuth.
  2. Avant d'appeler cette interface, vous devez d'abord créer une enveloppe avec un statut de brouillon via l'interface de création de processus de signature.
  3. Une fois l'ID du processus de signature créé, vous pouvez configurer l'enveloppe via des interfaces telles que l'ajout de fichiers de signature et l'ajout de signataires.
  4. La page de lancement générée par cette vue prend en charge l'intégration iframe et webview, et la langue de la page est l'anglais par défaut.
  5. L'appel de cette interface ne prend pas en charge les processus de signature qui incluent la signature silencieuse du signataire.

Paramètres de requête

Nom du paramètre

Type

Obligatoire

Description

envelopeId

string

true

ID du processus de signature, uniquement autorisé à transmettre l'ID du processus de signature 0-créé (brouillon)

returnUrl

string

true

Adresse de redirection une fois l'envoi du processus de signature terminé (longueur 2048), doit être conforme à l'adresse du protocole https/http

settingsobjectfalseParamètres personnalisés de la page d'envoi
 startingPagestringfalseEnvoyer la page de démarrage de la vue, preparePage par défaut.
preparePage - Page de configuration des informations de base
taggingPage - Page de configuration des contrôles de signature
 submitActionstringfalseSoumettre, send par défaut
save - Enregistrer, la page affiche le bouton d'enregistrement save, masquant les boutons liés à send ;
send - Envoyer, la page affiche les boutons send now, send, send later, masquant le bouton save ;
 showBackButtonbooleanfalseIndique si le bouton Retour de la page de marquage doit être affiché, true par défaut.
true - Afficher
false - Ne pas afficher
 

lockedArea

arrayfalse

Informations qui ne peuvent pas être modifiées dans senderView, vide par défaut. Les valeurs d'énumération incluent :

document - Signer le document

signerInfo - Informations sur le signataire

Exemple de requête

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

Paramètres de réponse

Nom du paramètre

Type

Description

url

string

Adresse de la page de lancement de l'enveloppe

Exemple de réponse

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

 

Description de l'interface
Paramètres de requête
Exemple de requête
Paramètres de réponse
Exemple de réponse