POST /esignglobal/v1/envelope/create
Description de l'interface Créer une enveloppe à l'état de brouillon.
Paramètres de requête Nom du paramètre
Type
Obligatoire
Description
subject
string
true
Sujet de l'enveloppe, exemple : "Offer Letter"
remark
string
false
Remarques sur l'enveloppe, limite de 1000 caractères
signerSettings
object
false
Opérations autorisées pour le signataire
allowTransfer
boolean
false
Autoriser le signataire à transférer cette enveloppe à une autre personne pour signature, false par défaut
true - Autoriser le signataire de l'enveloppe à avoir le pouvoir de transférer l'enveloppe à d'autres ;
false - Ne pas autoriser le signataire de l'enveloppe à avoir le pouvoir de transférer l'enveloppe à d'autres ;
allowModifyName
boolean
false
Autoriser le signataire à modifier son nom, uniquement valable pour la signature de modèle, false par défaut
true - Autoriser le signataire à modifier son nom
false - Le signataire n'est pas autorisé à modifier son nom
expireAfterSeconds
long
false
Délai d'expiration de l'enveloppe : après combien de secondes l'enveloppe expire-t-elle ?
Plage d'expiration : 86 400 secondes (1 jour) à 7 776 000 secondes (90 jours).
redirectUrl
string
false
Adresse de redirection après la signature (longueur 2048), doit être une adresse http valide
callBackUrl
string
false
Adresse de rappel (longueur 500), doit être une adresse de protocole https / http
Exemple de requête {
"subject": "api subject fdsfasdfafs",
"remark": "This is a remark",
"expireAfterSeconds": 888640,
"redirectUrl": "https://www.example.com"
}Paramètres de réponse Nom du paramètre
Type
Description
envelopeId
string
ID de l'enveloppe
envelopeStatus
int
État de l'enveloppe
0 - Créé (brouillon)
1 - En cours de signature
2 - Terminé
3-Expiré
5-Révoqué
Exemple de réponse {
"code": "0",
"data": {
"envelopeId": "9fbe6c8190824227bde29136b0145c81",
"envelopeStatus": 0
},
"message": "success"
}
