POST /esignglobal/v1/envelope/create
Paglalarawan ng Interface
Lumikha ng sobre sa estado ng draft.
Mga Parameter ng Kahilingan
Pangalan ng Parameter | Uri | Kinakailangan ba? | Paglalarawan |
subject | string | true | Paksa ng sobre, halimbawa: “Offer Letter” |
remark | string | false | Mga tala ng sobre, limitasyon sa haba na 1000 na salita |
signerSettings | object | false | Mga operasyon na pinapayagan para sa lumalagda |
| allowTransfer | boolean | false | Pinapayagan ba ang lumalagda na ilipat ang sobre na ito sa ibang tao upang lumagda, default ay false true-Pinapayagan ang lumalagda sa sobre na magkaroon ng kapangyarihan na ilipat ang sobre sa ibang tao; false-Hindi pinapayagan ang lumalagda sa sobre na magkaroon ng kapangyarihan na ilipat ang sobre sa ibang tao; |
| allowModifyName | boolean | false | Pinapayagan ba ang lumalagda na baguhin ang pangalan, epektibo lamang para sa lagda ng template, default ay false true-Pinapayagan ang lumalagda na baguhin ang pangalan false-Hindi pinapayagan ang lumagda na baguhin ang pangalan |
expireAfterSeconds | long | false | Expiration ng sobre: Pagkatapos ng ilang segundo, mag-e-expire ang sobre Saklaw ng expiration: 86,400 segundo (1 araw) ~ 7,776,000 segundo (90 araw). |
redirectUrl | string | false | I-redirect na address pagkatapos ng pagpirma (haba 2048), dapat ay isang valid na http address |
callBackUrl | string | false | Callback address (haba 500), dapat sumunod sa https /http protocol address |
Halimbawa ng kahilingan
{
"subject": "api subject fdsfasdfafs",
"remark": "This is a remark",
"expireAfterSeconds": 888640,
"redirectUrl": "https://www.example.com"
}
Mga parameter ng tugon
Pangalan ng parameter | Uri | Paglalarawan |
envelopeId | string | ID ng sobre |
envelopeStatus | int | Estado ng sobre 0-Nilikha na (draft) 1-Kasulukuyang pinipirmahan 2-Tapos na 3-Expired na 5-Kinansela na |
Halimbawa ng tugon
{
"code": "0",
"data": {
"envelopeId": "9fbe6c8190824227bde29136b0145c81",
"envelopeStatus": 0
},
"message": "success"
}