eSign.AIeSign.AI
ศูนย์นักพัฒนา

เพิ่มไฟล์ลายเซ็น

POST /esignglobal/v1/envelope/files/addSignFiles

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

เมื่อซองยังไม่ถูกเปิดใช้งาน สามารถเพิ่มไฟล์ที่ต้องการลงนามลงในซองได้ แต่ซองที่ถูกเปิดใช้งานแล้วจะไม่รองรับการเพิ่มไฟล์ลงนามเพิ่มเติม

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

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

ประเภท

จำเป็น

คำอธิบาย

envelopeId

string

true

ID ของซอง

signFiles

array

true

ชุดข้อมูลของไฟล์ลงนาม โดยลำดับการแสดงจะเป็นตามลำดับที่เพิ่มไฟล์

 

fileKey

string

true

fileKey ของไฟล์ลงนาม รองรับเฉพาะรูปแบบ PDF เท่านั้น

 documentFieldsarrayfalseรายการคอนโทรลระดับไฟล์ ใช้สำหรับเพิ่มคอนโทรลระดับไฟล์ที่ไม่ผูกกับผู้ลงนามบนไฟล์ที่กำหนด
  

fieldType

string

false

ประเภทคอนโทรล ส่งค่า eMeterai เพื่อแสดงถึงคอนโทรลภาษีอากรอินโดนีเซีย

  

pageNo

string

false

หมายเลขหน้าของคอนโทรล คอนโทรลภาษีอากรอินโดนีเซียรองรับเฉพาะการระบุหน้าเดียว ต้องส่งหมายเลขหน้าเพียงหนึ่งหน้า ไม่รองรับรูปแบบหลายหน้าต่อเนื่องหรือไม่ต่อเนื่อง เช่น 1-3, 1,3 เป็นต้น

  posXfloatfalseการเลื่อนแกน x จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า ขอบเขตพิกัดสอดคล้องกับขอบเขตพิกัดของคอนโทรลอื่นๆ
  posYfloatfalseการเลื่อนแกน y จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า ขอบเขตพิกัดสอดคล้องกับขอบเขตพิกัดของคอนโทรลอื่นๆ

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

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

พารามิเตอร์การตอบกลับ

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

ประเภท

คำอธิบาย

code

int

รหัสธุรกิจ, 0 หมายถึงสำเร็จ, ค่าที่ไม่ใช่ 0 หมายถึงเกิดข้อผิดพลาด

message

string

ข้อมูลธุรกิจ

【หมายเหตุ】 โปรดตรวจสอบสถานะข้อผิดพลาดตาม code ไม่ควรพึ่งพา message ในการจับคู่ เนื่องจาก message อาจมีการเปลี่ยนแปลงได้

data

object

ข้อมูลธุรกิจ

ตัวอย่างการตอบกลับ

{
    "code": "0",
    "message": "success",
    "data": null
}