Overview
MeeD Partner API ช่วยให้ระบบภายนอกสามารถเชื่อมต่อและเข้าถึงข้อมูลธุรกิจที่ใช้งาน MeeD POS ได้อย่างปลอดภัยผ่าน REST API มาตรฐาน โดยรองรับการใช้งานสำหรับผู้พัฒนาระบบ (Developers), ผู้ให้บริการ POS Integration, ระบบวิเคราะห์ข้อมูล (Analytics Platforms), ระบบบัญชี, ERP และ Dashboard ที่พัฒนาขึ้นเอง
ด้วย API ชุดนี้ ผู้พัฒนาสามารถดึงข้อมูลจาก MeeD ไปใช้งานต่อได้แบบ Programmatic เพื่อสร้างรายงาน วิเคราะห์ยอดขาย ซิงค์ข้อมูลระหว่างระบบ หรือพัฒนา Workflow อัตโนมัติตามความต้องการของธุรกิจ
Features
MeeD Partner API ครอบคลุมข้อมูลและบริการหลักของระบบ ได้แก่
| Domain | คำอธิบาย |
|---|---|
| Sales | ข้อมูลการขาย ใบเสร็จ รายการสินค้า และยอดขาย |
| Products | ข้อมูลสินค้า หมวดหมู่ หน่วยสินค้า และราคา |
| Inventory | ข้อมูลสต๊อกสินค้า การเคลื่อนไหวของสินค้า และคงเหลือ |
| Purchase Orders | เอกสารสั่งซื้อสินค้าและสถานะการรับสินค้า |
| Customers | ข้อมูลลูกค้าและประวัติการซื้อ |
| Reports | ข้อมูลสรุปสำหรับการวิเคราะห์และจัดทำรายงาน |
| Webhooks | การแจ้งเตือนเหตุการณ์แบบ Real-time ไปยังระบบภายนอก |
Common Use Cases
MeeD Partner API เหมาะสำหรับการใช้งาน เช่น
- สร้าง Dashboard และ Business Intelligence (BI)
- เชื่อมต่อกับระบบ ERP หรือ Accounting Software
- สร้างรายงานเฉพาะทางสำหรับผู้บริหาร
- ซิงค์ข้อมูลสินค้า ลูกค้า และยอดขายระหว่างหลายระบบ
- รับข้อมูลเหตุการณ์แบบ Real-time ผ่าน Webhooks
- พัฒนา Mobile App หรือ Web Application ที่ใช้ข้อมูลจาก MeeD
API Style
MeeD Partner API ใช้สถาปัตยกรรม RESTful API และรับส่งข้อมูลในรูปแบบ JSON ผ่าน HTTPS
ทุก Endpoint ต้องได้รับการยืนยันตัวตนด้วย OAuth 2.0 Access Token ก่อนเข้าถึงข้อมูล
Versioning
API ทุก Endpoint อยู่ภายใต้เวอร์ชันที่กำหนดใน URL เพื่อรองรับการพัฒนาและการเปลี่ยนแปลงในอนาคตโดยไม่กระทบกับ Integration ที่มีอยู่
/api/partner/v1/<endpoint>
ก่อนเริ่มต้น
| ข้อกำหนด | รายละเอียด |
|---|---|
| Plan | Business ขึ้นไป |
| สิทธิ์ผู้ใช้ | Role Owner (ใช้สร้าง API Application ใน Settings) |
| Protocol | HTTPS เท่านั้น |
| Data format | JSON (Content-Type: application/json) |
Getting Started
1. สร้าง API Application
ไปที่ Settings → Open API แล้วสร้าง application ใหม่ โดยระบุ:
| Field | คำอธิบาย |
|---|---|
name | ชื่อ application สำหรับอ้างอิง |
allowed_scopes | สิทธิ์ที่ต้องการ เช่น read:sales, read:inventory — ดูรายการทั้งหมดที่ Scopes & Error Codes |
branch_ids | UUID ของสาขาที่อนุญาต — ละไว้หมายถึงทุกสาขา |
ระบบจะออก client_id และ client_secret ให้ครั้งเดียว
Important: เก็บ
client_secretทันทีหลังสร้าง — ระบบไม่แสดงซ้ำและไม่สามารถกู้คืนได้
2. ขอ Access Token
ส่ง client_id + client_secret ผ่าน OAuth 2.0 client credentials flow เพื่อรับ Bearer token:
curl -X POST https://<host>/api/partner/v1/oauth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials&client_id=<client_id>&client_secret=<client_secret>"
Token มีอายุ 3,600 วินาที (1 ชั่วโมง) — ไม่มี refresh token ให้ขอใหม่ได้เลยเมื่อหมดอายุ
ดู request/response เต็มได้ที่ Get Access Token
3. เรียก API
แนบ token ใน Authorization header ทุก request:
curl https://<host>/api/partner/v1/sales \
-H "Authorization: Bearer <access_token>"
Authentication Flow
Base URL
https://<host>/api/partner/v1
ทุก Endpoint ในเอกสารนี้อ้างอิงจาก Base URL ข้างต้น โดยระบุเฉพาะ Path ของ Endpoint เท่านั้น
Rate Limits
Limit ขึ้นอยู่กับ plan ของธุรกิจ นับต่อ application ในทุกช่วง 15 นาที:
| Plan | Limit (/ 15 นาที) |
|---|---|
| FREE / BASIC | ไม่มีสิทธิ์เข้าถึง Partner API |
| STARTER | 100 requests |
| PRO | 300 requests |
| BUSINESS | 1,000 requests |
Rate Limit Headers
ทุก response มี headers เหล่านี้:
| Header | คำอธิบาย |
|---|---|
X-RateLimit-Limit | Limit สูงสุดของ plan |
X-RateLimit-Remaining | คงเหลือในช่วง 15 นาทีปัจจุบัน |
X-RateLimit-Reset | Unix timestamp ที่ window จะ reset |
Retry-After | วินาทีที่ต้องรอ (เฉพาะเมื่อได้รับ 429) |
Errors
Plan ไม่รองรับ Partner API — 403 access_denied
{
"error": "access_denied",
"message": "API access is not available on your current subscription plan."
}
เกิน rate limit — 429 rate_limited
{
"error": "rate_limited",
"message": "Rate limit exceeded. Max <N> requests per 15 minutes."
}
ดู error codes ทั้งหมดได้ที่ Scopes & Error Codes