1. ภาพรวม
เอกสารนี้จัดทำขึ้นเพื่ออธิบาย Scope (ขอบเขตสิทธิ์) ในระบบการอนุญาตใช้งานแอปพลิเคชัน eSignGlobal สำหรับนักพัฒนาพันธมิตรในระบบนิเวศ ในการเชื่อมต่อแอปพลิเคชัน นักพัฒนาจำเป็นต้องยื่นขอ Scope ที่สอดคล้องกับความต้องการของฟังก์ชันการทำงานทางธุรกิจจริง โดยแต่ละ Scope จะระบุรายการ OpenAPI ที่อนุญาตให้เรียกใช้ได้ภายใต้ขอบเขตสิทธิ์นั้นๆ แพลตฟอร์มจะควบคุมสิทธิ์ในการดำเนินการกับทรัพยากรที่เกี่ยวข้องของแอปพลิเคชันอย่างเข้มงวดตาม Scope ที่ได้รับอนุญาต
อินเทอร์เฟซการตรวจสอบสิทธิ์พื้นฐาน
ก่อนที่แอปพลิเคชันในระบบนิเวศจะเรียกใช้อินเทอร์เฟซอย่างเป็นทางการ จำเป็นต้องขอรับข้อมูลรับรองการเรียกใช้ผ่าน Authorization Endpoint ก่อน:
ชื่ออินเทอร์เฟซ | เส้นทางอินเทอร์เฟซ | คำอธิบายอินเทอร์เฟซ |
รับ AccessToken | POST /esignglobal/v1/oauth2/accessToken
| ผ่าน appid และ appsecret เพื่อรับ access_token สำหรับการตรวจสอบสิทธิ์ ใช้สำหรับร้องขอ eSignGlobal API ในนามของผู้ใช้เฉพาะราย โดย Token มีอายุการใช้งาน 24 ชั่วโมง |
ปัจจุบัน Scope ที่เปิดให้บริการในระบบนิเวศ eSignGlobal ประกอบด้วยหลักๆ ดังนี้:
signature: บริการลงนามอิเล็กทรอนิกส์หลัก
stamp: บริการจัดการตราประทับ
comparisons: บริการเปรียบเทียบสัญญา
2. รายละเอียด Scope และรายการอินเทอร์เฟซ
2.1 Scope: signature (บริการลงนามอิเล็กทรอนิกส์)
Scope นี้เป็นโดเมนสิทธิ์พื้นฐานและนิยมใช้งานมากที่สุด โดยประกอบด้วยอินเทอร์เฟซหลักแบบครบวงจรสำหรับธุรกิจการลงนามอิเล็กทรอนิกส์ เมื่อได้รับอนุญาตให้ใช้ Scope นี้ แอปพลิเคชันจะสามารถจัดการและดำเนินการตามขั้นตอนการทำงานสำหรับแม่แบบ เอกสารลงนาม (รวมไฟล์แนบ) ผู้มีส่วนเกี่ยวข้อง และกระบวนการทำงานแบบ Envelope หลักได้
โมดูลที่ 1: บริการแม่แบบ
ชื่ออินเทอร์เฟซ | คำอธิบายอินเทอร์เฟซ |
ดึงรายละเอียดองค์ประกอบแม่แบบของผู้ลงนาม | ดึงข้อมูลองค์ประกอบแม่แบบของผู้ลงนามที่กำหนดและการตั้งค่าคุณสมบัติที่เกี่ยวข้อง |
ดึงรายละเอียดแม่แบบ | ดึงข้อมูลครบถ้วนของแม่แบบเฉพาะเจาะจง รวมถึงรายละเอียดของฟิลด์และโครงสร้างไฟล์ |
กรอกข้อมูลในแม่แบบเพื่อสร้างไฟล์ | เติมข้อมูลทางธุรกิจลงในแม่แบบที่กำหนดและสร้างไฟล์รูปแบบ PDF อัตโนมัติ |
สืบค้นรายการแม่แบบ | สืบค้นรายการแม่แบบที่ใช้ได้ในบัญชีปัจจุบันแบบแบ่งหน้าหรือตามเงื่อนไขการกรองเฉพาะ |
สืบค้นรายละเอียดงานผสานไฟล์ | ค้นหาผลลัพธ์ขั้นสุดท้ายของการดำเนินการสร้างไฟล์จากเทมเพลตโดยใช้รหัสงานแบบอะซิงโครนัส |
โมดูลที่ 2: การจัดการไฟล์
ชื่อ API | รายละเอียด API |
อัปโหลดไฟล์ | อัปโหลดไฟล์ในเครื่องหรือไฟล์ในกระบวนการทางธุรกิจไปยังแพลตฟอร์ม เพื่อเตรียมใช้งานสำหรับการลงนามในขั้นตอนต่อไป |
รับพิกัดตามคำสำคัญ | ค้นหาข้อความในเอกสารที่อัปโหลดแล้ว และส่งคืนข้อมูลพิกัดตำแหน่งของคำสำคัญที่ตรงกัน |
ดาวน์โหลดไฟล์ | ดาวน์โหลดเอกสารที่ลงนามเสร็จสมบูรณ์เฉพาะเจาะจง ไฟล์ต้นฉบับ หรือไฟล์แนบทางธุรกิจอื่นๆ |
เพิ่มไฟล์สำหรับการลงนาม | ผูกไฟล์ที่อัปโหลดสำเร็จก่อนหน้านี้เข้ากับซองลงนามหรือกระบวนการทำงานเฉพาะเจาะจง |
ลบไฟล์สำหรับการลงนาม | นำไฟล์ที่อัปโหลดผิดหรือยังไม่จำเป็นต้องลงนามออกจากกระบวนการซองลงนาม |
เพิ่มไฟล์แนบ | เพิ่มไฟล์แนบคำอธิบายเพิ่มเติมลงในกระบวนการซองเอกสารหรือขั้นตอนการลงนาม |
ลบไฟล์แนบ | นำเอกสารไฟล์แนบที่กำหนดออกจากกระบวนการซองเอกสารหรือขั้นตอนการลงนาม |
โมดูลที่ 3: การจัดการผู้เข้าร่วม
ชื่ออินเทอร์เฟซ | คำอธิบายอินเทอร์เฟซ |
เพิ่มผู้ลงนาม | เพิ่มผู้เข้าร่วมลงนามที่ต้องดำเนินการเซ็นชื่อในกระบวนการซองเอกสารเฉพาะเจาะจง |
ลบผู้ลงนาม | นำผู้ลงนามที่ถูกยกเลิกออกจากระบวนการซองเอกสารเฉพาะเจาะจง |
เพิ่มผู้รับสำเนา | เพิ่มบทบาทผู้รับสำเนา โดยจะได้รับการแจ้งเตือนความคืบหน้าและสามารถดูเอกสารที่ลงนามเสร็จสมบูรณ์เท่านั้น |
ลบผู้รับสำเนา | นำบทบาทผู้รับสำเนาที่กำหนดออก |
โมดูลที่ 4: การจัดการซองเอกสาร
ชื่ออินเทอร์เฟซ | คำอธิบายอินเทอร์เฟซ |
สร้างซองด่วน | หากแพลตฟอร์มที่เชื่อมต่อใช้インターเฟซนี้สร้างซอง และเมื่อลงนามเสร็จสิ้น ระบบจะดำเนินการสิ้นสุดกระบวนการอัตโนมัติ โดยไม่ต้องเรียกใช้ 'สิ้นสุดซอง' ด้วยตนเอง |
สร้างซอง | ใช้สำหรับสร้างซองในสถานะแบบร่าง รองรับการกำหนดค่าหัวข้อการลงนาม การตั้งค่าผู้ลงนาม และพารามิเตอร์อื่นๆ |
เปิดซอง | เมื่อตรวจสอบยืนยันว่าเอกสารและรายชื่อผู้ลงนามทั้งหมดถูกต้องแล้ว จะทำการส่งมอบหมายงานลงนามไปยังขั้นตอนถัดไปอย่างเป็นทางการ |
สิ้นสุดซอง | สิ้นสุดซองด้วยตนเอง ก่อนที่ซองจะถูกสิ้นสุด ผู้ลงนามทุกคนต้องลงนามให้ครบถ้วน หลังจากกระบวนการสิ้นสุดแล้ว จะไม่สามารถแก้ไขข้อมูลหรือทรัพยากรใดๆ ได้ |
ดึงลิงก์การลงนาม | ดึงลิงก์สั้นเฉพาะสำหรับผู้ลงนามที่กำหนด หรือ URL ของหน้าลงนามที่สามารถโหลดได้โดยตรง |
ค้นหาข้อมูลรายละเอียดซอง | ดึงข้อมูลภาพรวมของซอง เอกสารที่เกี่ยวข้อง ผู้เข้าร่วมกระบวนการ และสถานะปัจจุบันของการดำเนินการ |
ยกเลิกซอง | ผู้ริเริ่มทำการเพิกถอนซองเอกสารลงนามที่ยังไม่เสร็จสมบูรณ์ทั้งหมดด้วยตนเอง |
ซองเอกสารติดตามการลงนาม | เมื่อซองเอกสารยังไม่เสร็จสิ้นการลงนาม ระบบจะสนับสนุนการส่งข้อความแจ้งเตือนติดตามไปยังผู้ลงนามที่ยังต้องลงนามแต่ยังไม่ได้ลงนาม โดยกำหนดระยะเวลาแจ้งเตือนซ้ำทุก 30 นาที |
รับที่อยู่หน้าดูตัวอย่างการลงนาม | หลังจากเปิดซองเอกสารแล้ว สามารถใช้ API นี้เพื่อดึงที่อยู่หน้าดูตัวอย่างการลงนามได้ โดยมีวัตถุประสงค์หลักเพื่อใช้ในแพลตฟอร์มที่เชื่อมต่อ ให้แก่ผู้ที่ไม่ใช่ผู้เข้าร่วมซองเอกสารสามารถดูไฟล์และติดตามความคืบหน้าการลงนามได้ |
สร้างมุมมองผู้ส่งซองเอกสาร | สร้างมุมมองผู้ส่งซองเอกสารผ่าน ID ของซองเอกสาร ภายใต้มุมมองนี้ ข้อมูลของผู้ริเริ่มในการเริ่มกระบวนการลงนามจะถูกแทนที่ด้วยข้อมูลผู้ใช้ที่ได้จากการตรวจสอบ Access Token ในระบบ OAuth |
2.2 Scope: stamp (บริการจัดการตราประทับ)
Scope นี้จัดทำขึ้นโดยเฉพาะสำหรับการจัดการและมอบสิทธิ์ในการควบคุมตราประทับองค์กรหรือตราประทับชื่อส่วนบุคคล เหมาะสำหรับระบบนิเวศของบุคคลที่สามที่ต้องการเพียงดูแลรักษาคลังตราประทับมาตรฐานของบริษัท (การเพิ่ม ลบ แก้ไข และค้นหาตราประทับ) โดยไม่ต้องเข้าไปแทรกแซงกระบวนการเริ่มลงนามโดยตรง
ชื่อ API | คำอธิบาย API |
ค้นหาและแสดงรายการตราประทับ | ใช้ AppID ที่ได้รับสิทธิ์ในการค้นหาตราประทับที่เกี่ยวข้อง เพื่อดึงข้อมูลรายการทรัพยากรตราประทับ |
สร้างตราประทับ | ใช้ AppID ที่ได้รับสิทธิ์ ในการสร้างตราประทับโดยส่งสตริงรหัส Base64 ของรูปภาพที่อัปโหลด (รองรับรูปแบบ PNG ขนาด 18 มม. ถึง 100 มม.) |
แก้ไขตราประทับ | แก้ไขข้อมูลต่างๆ เช่น ชื่อและรูปภาพของตราประทับที่สร้างไว้แล้ว |
ลบตราประทับ | ลบทรัพยากรตราประทับที่กำหนดออกอย่างถาวรเมื่อไม่มีความเชื่อมโยงกับธุรกิจอีกต่อไป |
2.3 Scope: comparisons (บริการเปรียบเทียบสัญญา)
Scope นี้ถูกออกแบบมาเฉพาะสำหรับโดเมนฟังก์ชันด้านกฎหมายสัญญาอัจฉริยะ อนุญาตให้แอปพลิเคชันพันธมิตรในระบบนิเวศสามารถเรียกใช้ความสามารถในการเปรียบเทียบข้อความและเวอร์ชันได้อย่างยืดหยุ่นในขั้นตอนการตรวจสอบสัญญาและการประเมินทางกฎหมายของตนเอง เพื่อควบคุมความแตกต่างก่อนและหลังการแก้ไขสัญญาได้อย่างรวดเร็ว
ชื่ออินเทอร์เฟซ | คำอธิบายอินเทอร์เฟซ |
รับหน้าผลลัพธ์การเปรียบเทียบสัญญา | รับที่อยู่หน้าแสดงผลแบบภาพของผลลัพธ์ความแตกต่างจากการเปรียบเทียบ |
ค้นหาข้อมูลรายละเอียดการเปรียบเทียบสัญญา | ดึงผลลัพธ์การเปรียบเทียบสัญญาผ่านรหัสธุรกิจการเปรียบเทียบสัญญา โดยประกอบด้วยจำนวนความแตกต่าง (จำนวนที่เพิ่ม ลบ และแก้ไข) รวมถึงเนื้อหาความแตกต่างโดยละเอียด (การระบุตำแหน่งรายละเอียด) |
