ศูนย์นักพัฒนา

สร้างมุมมองการส่งซองจดหมาย

POST /esignglobal/v1/envelopes/views/sender

คำอธิบายอินเทอร์เฟซ

สร้างมุมมองผู้ส่งซองจดหมายผ่าน ID ซองจดหมาย นักพัฒนาสามารถรวมมุมมองการส่งที่ได้รับจากอินเทอร์เฟซนี้เข้ากับแอปพลิเคชันบุคคลที่สามของตนเอง

  1. กระบวนการลงนามที่เริ่มต้นจากหน้าการเริ่มต้นการลงนามที่ได้รับจากมุมมองนี้ ผู้ริเริ่มจะเติมข้อมูลผู้ใช้ที่แยกวิเคราะห์จาก Access Token ใน oauth
  2. ก่อนที่จะเรียกอินเทอร์เฟซนี้ คุณต้องสร้างซองจดหมายในสถานะแบบร่างผ่านอินเทอร์เฟซการสร้างกระบวนการลงนามก่อน
  3. หลังจากสร้าง ID กระบวนการลงนามแล้ว คุณสามารถตั้งค่าซองจดหมายผ่านอินเทอร์เฟซต่างๆ เช่น การเพิ่มไฟล์ลงนามและการเพิ่มผู้ลงนาม
  4. หน้าที่สร้างโดยมุมมองนี้รองรับการฝัง iframe และ webview ภาษาของหน้าเริ่มต้นเป็นภาษาอังกฤษ
  5. การเรียกอินเทอร์เฟซนี้ไม่รองรับกระบวนการลงนามที่มีการลงนามแบบเงียบของผู้ลงนาม

พารามิเตอร์คำขอ

ชื่อพารามิเตอร์

ประเภท

จำเป็นหรือไม่

คำอธิบาย

envelopeId

string

true

ID กระบวนการลงนาม อนุญาตให้ป้อนเฉพาะ ID กระบวนการลงนาม 0-สร้างแล้ว (แบบร่าง)

returnUrl

string

true

ที่อยู่เปลี่ยนเส้นทางหลังจากกระบวนการส่งการลงนามเสร็จสมบูรณ์ (ความยาว 2048) ต้องเป็นไปตามที่อยู่โปรโตคอล https /http

settingsobjectfalseการตั้งค่าที่กำหนดเองของหน้าการส่ง
 startingPagestringfalseส่งหน้าเริ่มต้นของมุมมอง โดยค่าเริ่มต้นคือ preparePage
preparePage - หน้าการตั้งค่าข้อมูลพื้นฐาน
taggingPage - หน้าการตั้งค่าตัวควบคุมการลงนาม
 submitActionstringfalseส่ง, ค่าเริ่มต้นคือ send
save - บันทึก, หน้าจอแสดงปุ่มบันทึก save, ซ่อนปุ่มที่เกี่ยวข้องกับ send;
send - ส่ง, หน้าจอแสดงปุ่ม send now, send, send later, ซ่อนปุ่ม save;
 showBackButtonbooleanfalseว่าจะแสดงปุ่มย้อนกลับของ Tagging Page หรือไม่, ค่าเริ่มต้นคือ true
true - แสดง
false - ไม่แสดง
 

lockedArea

arrayfalse

ข้อมูลที่ไม่ได้รับอนุญาตให้แก้ไขใน senderView, ค่าเริ่มต้นคือว่างเปล่า ค่าที่แจงนับได้รวมถึง:

document - ไฟล์ลงนาม

signerInfo - ข้อมูลผู้ลงนาม

ตัวอย่างคำขอ

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

พารามิเตอร์การตอบสนอง

ชื่อพารามิเตอร์

ประเภท

คำอธิบาย

url

string

ที่อยู่หน้าซองจดหมายเริ่มต้น

ตัวอย่างการตอบสนอง

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

 

คำอธิบายอินเทอร์เฟซ
พารามิเตอร์คำขอ
ตัวอย่างคำขอ
พารามิเตอร์การตอบสนอง
ตัวอย่างการตอบสนอง