Trung tâm nhà phát triển

Tạo chế độ xem gửi phong bì

POST /esignglobal/v1/envelopes/views/sender

Mô tả giao diện

Thông qua id phong bì để tạo chế độ xem người gửi phong bì, nhà phát triển có thể tích hợp chế độ xem gửi trang mà họ nhận được thông qua giao diện này vào ứng dụng bên thứ ba của riêng họ

  1. Quy trình ký kết được khởi xướng thông qua trang khởi xướng ký kết thu được thông qua chế độ xem này, bên khởi xướng sẽ điền thông tin người dùng được phân tích cú pháp bởi Mã thông báo truy cập trong oauth
  2. Trước khi gọi giao diện này, bạn cần tạo một phong bì ở trạng thái bản nháp thông qua giao diện tạo quy trình ký kết
  3. Sau khi tạo id quy trình ký kết, bạn có thể đặt phong bì thông qua các giao diện như thêm tệp ký kết và thêm bên ký kết
  4. Trang khởi chạy do chế độ xem này tạo hỗ trợ nhúng iframe và webview, ngôn ngữ trang mặc định là tiếng Anh
  5. Việc gọi giao diện này không hỗ trợ quy trình ký kết bao gồm chữ ký im lặng của người ký

Tham số yêu cầu

Tên tham số

Loại

Bắt buộc hay không

Giải thích

envelopeId

string

true

ID quy trình ký kết, chỉ cho phép truyền ID quy trình ký kết 0-đã tạo (bản nháp)

returnUrl

string

true

Địa chỉ chuyển hướng sau khi quy trình gửi ký kết hoàn tất (độ dài 2048), phải tuân thủ địa chỉ giao thức https /http

settingsobjectfalseCài đặt tùy chỉnh trang gửi
 startingPagestringfalseGửi trang bắt đầu của chế độ xem, mặc định là preparePage.
preparePage - Trang cài đặt thông tin cơ bản
taggingPage - Trang cài đặt điều khiển ký
 submitActionstringfalseGửi, mặc định là send
save - Lưu, trang hiển thị nút lưu, ẩn các nút liên quan đến send;
send - Gửi, trang hiển thị các nút send now, send, send later, ẩn nút save;
 showBackButtonbooleanfalseCó hiển thị nút Quay lại của Trang gắn thẻ hay không, mặc định là true.
true - Hiển thị
false - Không hiển thị
 

lockedArea

arrayfalse

Thông tin không được phép sửa đổi trong senderView, mặc định là trống. Các giá trị liệt kê bao gồm:

document - Ký tài liệu

signerInfo - Thông tin người ký

Ví dụ yêu cầu

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

Tham số phản hồi

Tên tham số

Loại

Mô tả

url

string

Địa chỉ trang khởi tạo phong bì

Ví dụ phản hồi

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}

 

Mô tả giao diện
Tham số yêu cầu
Ví dụ yêu cầu
Tham số phản hồi
Ví dụ phản hồi