Open API

เชื่อมต่อทุกระบบด้วย Open API

เปิดให้เข้าถึงข้อมูลร้านค้าผ่าน RESTful API และรับการแจ้งเตือนแบบ Real-time ผ่าน Webhooks

ต้องใช้แพ็กเกจ Diamond หรือ PrivateShop ขึ้นไป
API Endpoints

ความสามารถหลักของ Open API

จัดการทุกส่วนของร้านค้าผ่าน RESTful API มาตรฐาน พร้อม Authentication ด้วย API Key

สินค้า & หมวดหมู่

CRUD สินค้า, หมวดหมู่, ตัวเลือกสินค้า (variants), รูปภาพ และราคา

GET / POST / PUT / DELETE

คำสั่งซื้อ & ออเดอร์

ดึง/สร้าง/อัปเดตออเดอร์, เปลี่ยนสถานะ, ดูประวัติการสั่งซื้อ

GET / POST / PUT

ลูกค้า & สมาชิก

ข้อมูลลูกค้า, แต้มสะสม, ระดับสมาชิก (tier), ประวัติการซื้อ

GET / POST / PUT

สต็อก & คลังสินค้า

เช็คสต็อก, ปรับจำนวน, โอนสินค้าระหว่างคลัง

GET / PUT

โปรโมชั่น & คูปอง

สร้าง/จัดการคูปองส่วนลด, กำหนดเงื่อนไขการใช้งาน

GET / POST / PUT / DELETE

การชำระเงิน & จัดส่ง

สถานะการชำระเงิน, tracking number, อัปเดตสถานะจัดส่ง

GET / PUT
Webhooks

Real-time Event Notifications

รับการแจ้งเตือนทันทีเมื่อเกิดเหตุการณ์สำคัญในร้านค้า — ส่ง HTTP POST ไปยัง endpoint ที่คุณกำหนด

Order Events

  • order.createdเมื่อมีคำสั่งซื้อใหม่
  • order.paidเมื่อชำระเงินสำเร็จ
  • order.packedเมื่อแพ็กสินค้าเรียบร้อย
  • order.shippedเมื่อจัดส่งสินค้า
  • order.completedเมื่อรับสินค้าสำเร็จ
  • order.billaddr_changeเมื่อเปลี่ยนที่อยู่ใบเสร็จ
  • order.shipaddr_changeเมื่อเปลี่ยนที่อยู่จัดส่ง
  • order.tag_updateเมื่ออัปเดต tag ออเดอร์

Product Events

  • product.updatedเมื่อข้อมูลสินค้าเปลี่ยนแปลง
  • stock.lowเมื่อสต็อกต่ำกว่าที่กำหนด

Customer Events

  • customer.registeredเมื่อมีสมาชิกใหม่ลงทะเบียน
  • customer.tier_changedเมื่อระดับสมาชิกเปลี่ยน
  • customer.point.changeเมื่อแต้มสะสมเปลี่ยนแปลง
เงื่อนไขการใช้งาน

ข้อกำหนดก่อนเปิดใช้งาน API

แพ็กเกจ Diamond หรือ PrivateShop ขึ้นไป

ลงนามยอมรับเงื่อนไขการใช้บริการ API (API Service Agreement)

รับผิดชอบความปลอดภัยของ API Key และข้อมูลที่รั่วไหลจากฝั่งผู้ใช้

Security Best Practices

  • เก็บ API Key ใน environment variable — อย่า hardcode ในโค้ด
  • ใช้ HTTPS เสมอ — ห้ามส่ง API Key ผ่าน HTTP
  • จำกัด IP Whitelist สำหรับ production environment
  • Rate Limit: 100 requests/นาที ต่อ API Key
  • Rotate API Key เป็นประจำ และ revoke ทันทีหากสงสัยว่ารั่วไหล
FAQ

คำถาม OpenAPI ที่พบบ่อย

ต้องการความช่วยเหลือด้านเทคนิค?

ทีมเทคนิคัลพร้อมช่วยเหลือคุณในการเชื่อมต่อ API และตั้งค่า Webhooks