ทั่วไป

Authentication

ทุก endpoint ของ 4SureSlip API ต้องยืนยันตัวตนด้วย API Secret ของร้านค้า ส่งผ่าน HTTP header เดียวเท่านั้น

ส่ง API Secret ผ่าน header

แนบ header Authorization ในทุกคำขอ โดยใช้รูปแบบ Bearer ตามด้วย API Secret ของร้านค้า

ตัวอย่าง header

Authorization: Bearer <API Secret>

curl -X GET "https://slip.thesurelab.com/api/account/info" \
  -H "Authorization: Bearer $API_SECRET"

เก็บ API Secret ไว้ฝั่งเซิร์ฟเวอร์เท่านั้น

อย่าใส่ค่า Secret ไว้ในโค้ดฝั่งเบราว์เซอร์ แอปมือถือ หรือ repository สาธารณะ ให้เก็บไว้ใน environment variable ของเซิร์ฟเวอร์แทน

1
เข้าสู่ระบบแล้วไปที่หน้า API Keys
เปิดเมนู API Keys ในแดชบอร์ด แล้วเลือกร้านค้าที่ต้องการสร้างคีย์ให้
2
กดสร้างคีย์ใหม่
ตั้งชื่อคีย์ให้สื่อถึงระบบที่จะนำไปใช้ เช่น pos-หน้าร้าน หรือ website-checkout เพื่อให้เพิกถอนทีหลังได้ถูกตัว
3
คัดลอก API Secret ทันที
ระบบเก็บเฉพาะค่าที่เข้ารหัสไว้ ไม่สามารถแสดงค่าเดิมซ้ำได้อีก ถ้าทำหาย ให้เพิกถอนแล้วสร้างใหม่
4
ตั้งค่า IP Whitelist
ระบุ IP ของเซิร์ฟเวอร์ที่จะเรียก API ได้สูงสุด 10 รายการ หรือปล่อยเป็นค่าเริ่มต้นเพื่ออนุญาตทุก IP

หนึ่งคีย์ระบุ IP ที่อนุญาตได้ไม่เกิน 10 รายการ เหมาะกับการล็อกให้เรียกได้เฉพาะเซิร์ฟเวอร์ของคุณเท่านั้น

คีย์ที่สร้างใหม่จะใช้ค่า * ซึ่งอนุญาตทุก IP แนะนำให้เปลี่ยนเป็น IP จริงของระบบคุณเมื่อขึ้นใช้งานจริง

เมื่อ IP ไม่อยู่ในรายการที่อนุญาต

ระบบจะตอบกลับ HTTP 403 พร้อมข้อความ IP address not allowed โดยไม่หักโทเคน

รหัส HTTP ที่เกิดจากการยืนยันตัวตนไม่ผ่าน
HTTP	ข้อความ	สาเหตุ
401	`Missing Authorization header`	ไม่ได้แนบ header Authorization มาเลย
401	`Invalid Authorization header`	แนบ header มาแต่ไม่มีค่า Secret ต่อท้าย
401	`Invalid API secret`	Secret ไม่ถูกต้อง หรือคีย์ถูกเพิกถอนไปแล้ว
403	`IP address not allowed`	IP ผู้เรียกไม่อยู่ใน IP Whitelist ของคีย์นี้
402	`Package expired`	แพ็กเกจของร้านค้าหมดอายุแล้ว ต้องต่ออายุก่อนใช้งาน

ดูรหัสผลลัพธ์ทางธุรกิจทั้งหมดได้ที่หน้า Response