การอนุญาต oAuth

POST /esignglobal/v1/oauth2/accessToken

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

ผ่านapp_idและapp_secretรับการตรวจสอบสิทธิ์access_tokenเพื่อใช้ในการร้องขอ eSignGlobal API ในนามของผู้ใช้เฉพาะ Token มีอายุ 24 ชั่วโมง

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

ชื่อพารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
client_id	string	true	บัญชีแอปพลิเคชัน เช่น app_id โปรดลงทะเบียนบัญชี eSignGlobal และสร้างแอปพลิเคชันก่อน
client_secret	string	true	รหัสผ่านแอปพลิเคชัน เช่น app_secret โปรดลงทะเบียนบัญชี eSignGlobal และสร้างแอปพลิเคชันก่อน
grant_type	string	true	ประเภทการให้สิทธิ์ รองรับประเภทต่อไปนี้: client_credentials：ใช้ client_id และ client_secret เพื่อแลกเปลี่ยน access_token authorization_code：ต้องให้ผู้ใช้เข้าร่วมในกระบวนการอนุมัติ (มีอายุ 365 วันตามธรรมชาติ) หลังจากได้รับอนุมัติแล้ว จะสามารถรับ access_token และ refresh_token ได้ refresh_token：ภายในระยะเวลาที่ได้รับอนุมัติ และ refresh_token ยังคงใช้งานได้ สามารถขยายอายุของ refresh_token ได้โดยการรีเฟรช
code	string	false	รหัสอนุมัติ ซึ่งส่งคืนโดย eSignGlobal หลังจากที่ผู้ใช้ให้สิทธิ์ จำเป็นต้องส่งเมื่อ grant_type คือ authorization_code
refresh_token	string	false	รีเฟรชโทเค็น จำเป็นต้องระบุรีเฟรชโทเค็นเมื่อ grant_type คือ refresh_token เท่านั้น

พารามิเตอร์ทั้งหมดต้องส่งผ่าน multipart/form-data รูปแบบฟอร์ม ไม่สามารถใช้เป็นพารามิเตอร์การค้นหา URL หรือเนื้อหาคำขอ JSON ได้

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

curl --location 'http://………………/esignglobal/v1/oauth2/accessToken' \
--form 'client_id="LZn…………g89"' \
--form 'client_secret="5ugL0rM………………Yne7b"' \
--form 'grant_type="client_credentials"' \

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

ชื่อพารามิเตอร์	ประเภท	คำอธิบาย
access_token	string	โทเค็นการตรวจสอบสิทธิ์，ใช้สำหรับการตรวจสอบสิทธิ์คำขอ API มีอายุ 1 วันตามธรรมชาติ
expires_in	int	เวลาที่เหลือจนกว่าโทเค็นจะหมดอายุ หน่วย: วินาที
scope	string	ขอบเขตการอนุญาต เมื่อ grant_type คือ client_credentials จะคืนค่าคงที่:read-write เมื่อ grant_type คือ authorization_code หรือ refresh_token จะคืนค่าขอบเขตการอนุญาตที่เกี่ยวข้อง
token_type	string	ประเภทโทเค็น ค่าคงที่: bearer
refresh_token	string	ใช้สำหรับรีเฟรชโทเค็น จะคืนค่าเมื่อ grant_type คือ authorization_code หรือ refresh_token เท่านั้น มีอายุ 30 วันตามธรรมชาติ หลังจากหมดอายุจะต้องให้สิทธิ์ใหม่

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

{
    "access_token": "eyJhbGciOiJIUzI1N………………th1pMM3oYk",
    "expires_in": 86398,
    "scope": "read-write",
    "token_type": "bearer"
}