Créer une enveloppe

POST /esignglobal/v1/envelope/create

Description de l'interface

Créer un enveloppe en état brouillon.

Paramètres de requête

Nom du paramètre		Type	Obligatoire	Description
subject		string	true	Sujet de l'enveloppe, exemple : « Lettre d'offre »
remark		string	false	Remarque sur l'enveloppe, limite de longueur : 1000 caractères
signerSettings		object	false	Opérations autorisées pour le signataire
	allowTransfer	boolean	false	Autoriser ou non le signataire à transférer l'enveloppe à une autre personne pour signature, par défaut false true- Autoriser les signataires de l'enveloppe à transférer celle-ci à d'autres personnes ; false- Ne pas autoriser les signataires de l'enveloppe à transférer celle-ci à d'autres personnes ;
	allowModifyName	boolean	false	Autoriser ou non le signataire à modifier son nom, applicable uniquement aux signatures de modèle, par défaut false true- Autoriser le signataire à modifier son nom false- Le signataire n'est pas autorisé à modifier son nom
tspScope		array	false	Portée TSP de niveau enveloppe, par défaut false. Une fois spécifié, lors de l'ajout d'un signataire, il est nécessaire de sélectionner le TSP que le signataire doit utiliser dans la portée spécifiée. Les valeurs énumérées incluent : vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni、belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia、estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom、harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId、mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign、smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe、certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha。
expireAfterSeconds		long	false	Date d'expiration de l'enveloppe : nombre de secondes après lesquelles l'enveloppe expire Plage d'expiration : de 86 400 secondes (1 jour) à 7 776 000 secondes (90 jours).
redirectUrl		string	false	Adresse de redirection après achèvement de la signature (longueur 2048), doit être une adresse http valide
callBackUrl		string	false	Adresse de rappel (longueur 500), doit respecter le protocole https/http

Exemple de requête

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "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"
}