เชื่อม Chann1 กับระบบบัญชีหรือ ERP ของร้านConnect Chann1 to your accounting or ERP system

เริ่มใช้งานGetting started

1. สร้าง API keyCreate an API key

   เจ้าของร้านเปิด Dashboard › จัดการร้าน › API แล้วกด "สร้าง key" ตั้งชื่อตามระบบที่จะเชื่อม เช่น ระบบบัญชี key จะแสดงเต็มแค่ครั้งเดียว ให้คัดลอกเก็บไว้ทันทีThe shop owner opens Dashboard › Manage shop › API and creates a key named after the system it's for, such as Accounting. The full key is shown only once, so copy it right away.

2. ทดสอบด้วย /meTest with /me

   เรียก GET /me พร้อม key ใน header ถ้าได้ชื่อร้านกลับมา แปลว่าเชื่อมต่อสำเร็จCall GET /me with the key in the header. If your shop's name comes back, you're connected.

3. ซิงก์เฉพาะที่เปลี่ยนSync only what changed

   ครั้งถัดไปส่ง updated_since เป็นเวลาที่ซิงก์ครั้งก่อน จะได้เฉพาะรายการที่แก้หลังจากนั้นOn later runs, pass updated_since with your last sync time to get only records changed since then.

# API host ของคุณจะแจ้งพร้อมเปิดใช้ APIYour API host is provided when API access is enabled
curl https://<api-host>/api/ext/v1/me \
  -H "Authorization: Bearer chann_live_…"

ยืนยันตัวตนและข้อผิดพลาดAuthentication & errors

• ส่ง key ทุกครั้งใน header Authorization: Bearer <key> key ขึ้นต้นด้วย chann_live_Send the key on every request as Authorization: Bearer <key>. Keys start with chann_live_.
• key หนึ่งตัวผูกกับร้านเดียว และเข้าถึงได้เฉพาะ 8 กลุ่มข้อมูลในหน้านี้ ไม่มีการจัดการสมาชิก บทบาท หรือการตั้งค่าร้านผ่าน APIEach key belongs to one shop and reaches only the 8 resource groups on this page. Members, roles and shop settings are not available through the API.
• เพิกถอน key ได้ทุกเมื่อจากหน้า API หรือพิมพ์ในแชท LINE ของร้าน การเรียกด้วย key ที่เพิกถอนแล้วจะได้ 401 ทันทีRevoke a key any time from the API page or in your shop's LINE chat. Calls with a revoked key get 401 immediately.
• ในประวัติการใช้งานของร้าน ผู้ทำรายการผ่าน API จะแสดงเป็น api:<key id> จึงแยกได้ว่ารายการไหนมาจากระบบภายนอกIn the shop's activity history, API changes show the actor as api:<key id>, so you can tell which records came from outside systems.

# ทุกข้อผิดพลาดใช้รูปแบบเดียวกันEvery error has the same shape
{ "error": { "code": "unknown_or_revoked_key", "message": "…" } }

รายการและการซิงก์Lists & incremental sync

• ทุก endpoint แบบรายการรับ limit (1–200 ค่าเริ่มต้น 50) และ offset (ค่าเริ่มต้น 0)Every list endpoint takes limit (1–200, default 50) and offset (default 0).
• ผลลัพธ์มี items, total, limit, offset และ header X-Total-CountResponses include items, total, limit, offset and an X-Total-Count header.
• updated_since (ISO-8601) ใช้ได้กับ customers, deals, invoices และ tickets คืนเฉพาะรายการที่แก้หลังเวลานั้นupdated_since (ISO-8601) works on customers, deals, invoices and tickets and returns only records changed after that time.
• ลูกค้าที่ร้านรวมเข้ากับอีกรายแล้วจะไม่อยู่ในรายการ ส่วน GET /customers/{id} ของรายนั้นยังตอบ 200 พร้อม merged_into_id และ merged_into (id, customer_id, name) ใช้ย้ายข้อมูลฝั่งคุณไปหารายหลักA customer the shop has merged into another one is left out of lists. GET /customers/{id} for it still returns 200 with merged_into_id and merged_into (id, customer_id, name), so you can re-key your records to the surviving customer.

curl "https://<api-host>/api/ext/v1/customers?updated_since=2026-09-01T00:00:00%2B07:00&limit=100" \
  -H "Authorization: Bearer chann_live_…"

{ "items": [ … ], "total": 128, "limit": 100, "offset": 0 }

ตัวอย่าง: ออกใบแจ้งหนี้และบันทึกรับชำระExample: issue an invoice and record payment

ออกใบแจ้งหนี้จากดีลที่มีสินค้าแล้ว ขอลิงก์ PDF แล้วบันทึกว่ารับชำระเต็มยอด ใบแจ้งหนี้จะเปลี่ยนเป็นชำระแล้ว และเห็นตรงกันใน DashboardInvoice a deal that has line items, get the PDF link, then record full payment. The invoice becomes paid and shows the same in the Dashboard.

# 1 · ออกใบแจ้งหนี้และ PDF ทันทีCreate the invoice and issue its PDF
POST /api/ext/v1/invoices
{ "deal_id": "<deal id>", "issue": true }

# 2 · ขอลิงก์ PDFGet the PDF link
GET /api/ext/v1/invoices/<invoice id>/pdf

# 3 · บันทึกรับชำระเต็มยอดRecord full payment
POST /api/ext/v1/invoices/<invoice id>/payments
{ "full": true, "method": "transfer" }

Endpoints

path ทั้งหมดต่อท้าย /api/ext/v1 · สร้างใหม่ตอบ 201 · ข้อมูลไม่ถูกต้องตอบ 422All paths are relative to /api/ext/v1 · creates return 201 · invalid input returns 422