Authentication

PointUpCRM Public API ใช้การยืนยันตัวตนผ่าน API Key โดยทุกคำขอจากระบบ POS หรือระบบภายนอกจะต้องส่ง API Key มาพร้อมกับ Request Header ทุกครั้ง

ระบบจะตรวจสอบ API Key เพื่อยืนยันว่า Request นั้นมาจากร้านค้า สาขา หรือระบบที่ได้รับอนุญาตให้เชื่อมต่อกับ PointUpCRM

API Key Header

ให้ส่ง API Key ผ่าน Header ชื่อ X-CRMPlus-Api-Key

Test Authentication

หลังจากได้รับ API Key แล้ว สามารถทดสอบการเชื่อมต่อและตรวจสอบว่า API Key ใช้งานได้หรือไม่ ด้วย Endpoint นี้

Example Request

Success Response

หาก API Key ถูกต้อง ระบบจะตอบกลับสถานะ 200 OK พร้อมข้อมูลร้านค้าและสิทธิ์การใช้งานของ API Key

{
  "tenantId": "005a1db5-6653-4792-81f6-ce4444c1c1e4",
  "tenantName": "aaa",
  "slug": "aaa",
  "loyaltyMode": "Points",
  "keyName": "ddd",
  "scopes": [
    "members:read",
    "members:write",
    "wallets:read",
    "earn:write",
    "receipt-qr:write",
    "transactions:read"
  ]
}

Response Fields

Field	Description
`tenantId`	รหัสร้านค้า / Tenant ที่ผูกกับ API Key
`tenantName`	ชื่อร้านค้าหรือองค์กร
`slug`	ชื่อย่อหรือ slug ของร้านค้า
`loyaltyMode`	รูปแบบระบบสะสมแต้ม เช่น `Points`
`keyName`	ชื่อของ API Key ที่ใช้งาน
`scopes`	สิทธิ์การใช้งานที่ API Key นี้สามารถเรียกได้

Unauthorized Response

หากไม่ส่ง API Key หรือ API Key ไม่ถูกต้อง ระบบจะตอบกลับสถานะ 401 Unauthorized

{
  "message": "Invalid or missing API key."
}

Security Notice

API Key ควรถูกใช้งานจากระบบ Backend, POS Server หรือระบบหลังบ้านของร้านค้าเท่านั้น ไม่ควรนำ API Key ไปแสดงหรือเรียกใช้งานโดยตรงจากฝั่ง Client, Browser, JavaScript หน้าเว็บไซต์ หรือแอปพลิเคชันที่ผู้ใช้งานสามารถเข้าถึงได้

หาก API Key ถูกเปิดเผยหรือสงสัยว่ามีการใช้งานผิดปกติ ควรปิดใช้งาน API Key เดิมและสร้าง API Key ใหม่ทันที

API Key Header#

Test Authentication#

Example Request#

Success Response#

Response Fields#

Unauthorized Response#