Lumikha ng balat

POST /esignglobal/v1/envelope/create

Deskripsyon ng Interface

Gumawa ng envelope na nasa draft state.

Mga Parameter ng Request

Pangalan ng Parameter		Uri	Kailangan ba?	Paliwanag
subject		string	true	Paksa ng envelope, halimbawa: "Offer Letter"
remark		string	false	Tala sa envelope, limitasyon ng haba ay 1000 karakter
signerSettings		object	false	Mga aksyon na pinapayagan para sa mga signatory
	allowTransfer	boolean	false	Pinapayagan ba ang signatory na i-forward ang envelope sa ibang tao para mag-sign, default false true-Pinapayagan ang mga signatory sa loob ng envelope na may kapangyarihan na i-forward ang envelope sa iba; false-Hindi pinapayagan ang mga signatory sa loob ng envelope na may kapangyarihan na i-forward ang envelope sa iba;
	allowModifyName	boolean	false	Pinapayagan ba ang signatory na baguhin ang pangalan, lamang para sa template signature, default false true-Pinapayagan ang signatory na baguhin ang pangalan false-Hindi pinapayagang baguhin ng tagapirm ang pangalan
tspScope		array	false	Saklaw ng TSP para sa envelope, default na false. Kapag itinakda, habang idinadagdag ang mga tagapirm, kailangang piliin mula sa itinakdang saklaw ang TSP na gagamitin ng tagapirm. Kasama sa mga enum value ang: 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	Oras ng pag-expire ng envelope: Pagkatapos ng ilang segundo, mag-e-expire ang envelope Saklaw ng pag-expire: 86,400 segundo (1 araw) ~ 7,776,000 segundo (90 araw).
redirectUrl		string	false	Redirect address pagkatapos ng pagpirmahan (haba 2048), dapat valid na http address
callBackUrl		string	false	Callback address (haba 500), dapat sumusunod sa https/http protocol address

Halimbawa ng request

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Mga parameter ng response

Pangalan ng parameter

Uri

Paliwanag

envelopeId

string

ID ng envelope

envelopeStatus

int

Estado ng envelope

0-Nalikha (draft)

1-Pinagsasailaliman

2-Natapos na

3-Nag-expire na

5-Nabuwag na

Halimbawa ng tugon

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}