Tạo phong bì

POST /esignglobal/v1/envelope/create

Mô tả giao diện

Tạo phong bì ở trạng thái bản nháp.

Tham số yêu cầu

Tên tham số		Kiểu dữ liệu	Bắt buộc	Mô tả
subject		string	true	Chủ đề phong bì, ví dụ: “Offer Letter”
remark		string	false	Ghi chú phong bì, giới hạn độ dài 1000 ký tự
signerSettings		object	false	Các thao tác cho phép người ký thực hiện
	allowTransfer	boolean	false	Có cho phép người ký chuyển phong bì này cho người khác ký hay không, mặc định là false true- Cho phép người ký trong phong bì có quyền chuyển phong bì cho người khác; false- Không cho phép người ký trong phong bì có quyền chuyển phong bì cho người khác;
	allowModifyName	boolean	false	Có cho phép bên ký sửa đổi tên hay không, chỉ áp dụng cho chữ ký mẫu, mặc định là false true- Cho phép người ký sửa đổi tên false-Không cho phép người ký sửa đổi tên
tspScope		array	false	Phạm vi TSP cấp độ phong bì, mặc định là false. Sau khi chỉ định, khi thêm người ký, cần chọn TSP mà người ký sẽ sử dụng từ phạm vi đã chỉ định. Các giá trị liệt kê bao gồm: 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	Thời gian hết hạn của phong bì: số giây sau đó phong bì hết hạn Phạm vi hết hạn: từ 86,400 giây (1 ngày) đến 7,776,000 giây (90 ngày).
redirectUrl		string	false	Địa chỉ chuyển hướng sau khi ký xong (độ dài tối đa 2048), phải là địa chỉ http hợp lệ
callBackUrl		string	false	Địa chỉ callback (độ dài tối đa 500), phải tuân thủ giao thức https/http

Ví dụ yêu cầu

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

Tham số phản hồi

Tên tham số

Kiểu dữ liệu

Mô tả

envelopeId

string

ID phong bì

envelopeStatus

int

Trạng thái phong bì

0-Đã tạo (bản nháp)

1-Đang ký

2-Đã hoàn thành

3-Đã hết hạn

5-Đã hủy

Ví dụ phản hồi

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