OTP (One Time Password)

One time password.

OTP หรือ One Time Password คือชุดรหัสผ่านแบบใช้ครั้งเดียว เพื่อความปลอดภัย ในการทำธุรกรรมทางอิเล็กทรอนิกส์ ที่ระบบจะส่งไปยัง SMS โทรศัพท์มือถือคุณ เพื่อใช้ตรวจสอบและยืนยันการเป็นเจ้าของบัญชีก่อนการเข้าถึงและเปลี่ยนแปลงข้อมูลส่วนตัวต่าง ๆ ซึ่งรหัสผ่านชุดนี้จะมีอายุตามที่ตั้งค่าในระบบ หากเลยเวลาจะไม่สามารถนำกลับมาใช้ได้อีก ทั้งนี้ OTP เป็นส่วนหนึ่งของระบบที่ช่วยลดความเสี่ยงในการทำธุรกรรมทางอินเทอร์เน็ตได้อย่างมีประสิทธิภาพ

RequestOTP

ใช้สำหรับการขอชุดรหัสผ่าน เพื่อทำธุรกรรมทางอิเล็กทรอนิกส์ไปยัง SMS โทรศัพท์มือถือคุณ เพื่อใช้ตรวจสอบและยืนยันการเป็นเจ้าของบัญชี

Sequence Diagram

รูปภาพ Sequence Diagram (API RequestOTP)

Request

ผู้ใช้งานสามารถเริ่มสร้าง HTTP ตามรายละเอียดดังนี้

หัวข้อ	รายละเอียด
HTTP Request (URL)	https://api-service.ants.co.th/otp/requestOTP
HTTP Headers	Content-Type: application/json Authorization: (Basic Auth) Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP Methods	POST

ผู้ใช้งานต้องระบุ Request body ด้วย Parameter ดังนี้

ตัวแปร Parameter	ประเภทข้อมูล	รายละเอียด
otcId	String	เป็นรหัสลงทะเบียนเข้าใช้งานระบบ OTP เพื่อดูการตั้งค่า
mobile	String	เบอร์โทรศัพท์มือถือ
notifyUrl (optional)	String	ท่านสามารถกำหนด URL บน callback server ที่ต้องการ ให้ส่งรายงานผล (Delivery report) โดยสามารถกำหนด API สำหรับรับ Callback ตามลิ้งค์นี้ Send Callback
notifyContentType (optional)	String	กำหนด content type ของ รายงานผล Delivery report เป็น application/json
callbackData (optional)	String	ระบุค่าที่ต้องการส่งกลับ เมื่อระบุ notifyUrl จะส่งค่า callbackData นี้กลับไป

ตัวอย่าง Request JSON

{
 	"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
 	"mobile": "66123456789",
  "notifyUrl": "https://testSendOTP",
  "notifyContentType": "application/json",
  "callbackData":"OTP Data"
}

Response

Response ตอบกลับผู้ใช้งาน ดังนี้

ชุดข้อมูลผลลัพธ์	ประเภทข้อมูล	รายละเอียด
otcId	String	เป็นรหัสลงทะเบียนเข้าใช้งานระบบ OTP เพื่อดูการตั้งค่า
otpId	String	เป็นรหัสการส่งข้อความ OTP
referenceCode	String	รหัสอ้างอิง (ref Code)
status	Object	สถานะการส่งข้อความ
message	String	ชื่อสถานะ
description	String	รายละเอียดสถานะ

ตัวอย่าง Response JSON

{
    	"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
    	"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
    	"referenceCode": "IpA6k",
     	"success": {
        		"message": "success",
        		"description": ""
    	}
}

ResendOTP

ใช้สำหรับส่งชุดรหัสผ่าน เพื่อทำธุรกรรมทางอิเล็กทรอนิกส์ไปยัง SMS โทรศัพท์มือถือคุณ เพื่อใช้ตรวจสอบและยืนยันการเป็นเจ้าของบัญชี อีกครั้ง

Sequence Diagram

Request

ผู้ใช้งานสามารถเริ่มสร้าง HTTP ตามรายละเอียดดังนี้

หัวข้อ	รายละเอียด
HTTP Request (URL)	https://api-service.ants.co.th/otp/resendOTP
HTTP Headers	Content-Type: application/json Authorization: (Basic Auth) Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP Methods	POST

ผู้ใช้งานต้องระบุ Request body ด้วย Parameter ดังนี้

ตัวแปร Parameter	ตัวแปร Parameter	รายละเอียด
otpId	string	เป็นรหัสการส่งข้อความ OTP

ตัวอย่าง Request JSON

{
"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
}

Response

Response ตอบกลับผู้ใช้งาน ดังนี้

ชุดข้อมูลผลลัพธ์	ประเภทข้อมูล	รายละเอียด
otcId	String	เป็นรหัสลงทะเบียนเข้าใช้งานระบบ OTP เพื่อดูการตั้งค่า
otpId	String	เป็นรหัสการส่งข้อความ OTP
referenceCode	String	รหัสอ้างอิง (ref Code)
status	Object	สถานะการส่งข้อความ
message	String	ชื่อสถานะ
description	String	รายละเอียดสถานะ

ตัวอย่าง Response JSON

{
"otcId": "0DC8E7AD-0168-440C-AF10-BF556B164D83",
"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
"referenceCode": "IpA6k",
"success": {
	"message": "success",
	"description": ""
	}
}

VerifyOTP

ใช้สำหรับตรวจสอบชุดรหัสผ่าน และยืนยันการเป็นเจ้าของบัญชี

Sequence Diagram

รูปภาพ Sequence Diagram (API VerifyOTP)

Request

ผู้ใช้งานสามารถเริ่มสร้าง HTTP ตามรายละเอียดดังนี้

หัวข้อ	รายละเอียด
HTTP Request (URL)	https://api-service.ants.co.th/otp/verifyOTP
HTTP Headers	Content-Type: application/json Authorization: (Basic Auth) Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP Methods	POST

ผู้ใช้งานต้องระบุ Request body ด้วย Parameter ดังนี้

ตัวแปร Parameter	ประเภทข้อมูล	รายละเอียด
otpId	String	เป็นรหัสการส่งข้อความ OTP
otpCode	String	รหัส OTP

ตัวอย่าง Request JSON

{
    "otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
   	"otpCode": "79895"
}

Response

Response ตอบกลับผู้ใช้งาน ดังนี้

ชุดข้อมูลผลลัพธ์	ประเภทข้อมูล	รายละเอียด
otpId	String	เป็นรหัสการส่งข้อความ OTP
result	Boolean	ผลการยืนยัน OTP
isErrorCount	Boolean	ผลการกรอก OTP ผิดพลาด
isExprCode	Boolean	ผลการกรอก OTP เกินระยะเวลาที่กำหนด

ตัวอย่าง Response JSON

{
    	"otpId": "0c342e74-a9c7-4bbd-8da4-b36a49bbc0d6",
    	"result": true,
    	" isErrorCount": false,
    	"isExprCode": false
}

สถานะผลลัพธ์ตอบกลับ (Response Status)

ในการใช้งาน API ท่านจะได้รับสถานะตอบกลับต่าง ๆ เพื่อที่จะเข้าใจถึงเหตุผล ปัจจัยต่าง ๆ และสามารถแก้ไขปัญหา ได้ตรงจุด ข้อมูลด้านล่างเป็นการอธิบายรายการของรหัส แหตุผล และคำอธิบายต่าง ๆ

Status Code

นอกเหนือจาก สถานะ HTTP status code มาตราฐานแล้ว สถานะเหล่านั้นอาจจะส่งมาในส่วนของ API response status

ตัวอย่าง สถานะผลลัพธ์ API Response Error

{
	  "error": {
		"message": "Invalid OTP Config",
		"description": ""
             }
}

Status Code

Code	Message EN	Message TH
0000	Success	สำเร็จ
9999	Exception	ผิดพลาด
9998	Authentication failed	username or password ผิดพลาด
9996	Bad Request	คำสั่งไม่ถูกต้อง
9995	Credit not enough	เครดิตหมด
0301	Invalid OTP Config	ตั้งค่า OTP ไม่ถูกต้อง
0302	Number Prefix Missing	ไม่มีคำนำหน้า
0303	No Data Available OTP	ไม่พบข้อมูล OTP
0304	Over Limit Usage	กรอกข้อมูลเกินจำนวนครั้งที่กำหนด
0305	OTP Code Expired	OTP Code หมดอายุ
0306	OTP Code Confirmed	OTP Code ยืนยันตัวตนไปแล้ว
0307	Invalid Number	หมายเลขไม่ถูกต้อง