> For the complete documentation index, see [llms.txt](https://help.zaapi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.zaapi.com/th/developers/open-api.md).

# Open API

Zaapi Open API ช่วยให้บริการขององค์กรสามารถอ่านและเขียนข้อมูลในเวิร์กสเปซได้แบบโปรแกรมเมติก — ดึงทิกเก็ตเข้าไปยังแดชบอร์ด BI ซิงก์รายชื่อผู้ติดต่อกับ CRM ส่งข้อความจากเครื่องมือภายใน หรือส่งอัปเดตกลับเข้า Zaapi จากระบบภายใน

**เอกสารอ้างอิง API แบบเต็มอยู่ที่** [**docs.zaapi.com**](https://docs.zaapi.com/)**.** หน้านี้เป็นภาพรวมแบบย่อ: API ครอบคลุมอะไรบ้าง วิธีขอคีย์ และขั้นตอนถัดไป

### สิ่งที่ใช้งานได้

| ทรัพยากร                    | สิ่งที่ทำได้                                                                          |
| --------------------------- | ------------------------------------------------------------------------------------- |
| **ทิกเก็ต**                 | แสดงรายการและอ่านทิกเก็ต อัปเดต Custom Fields และปิดทิกเก็ต                           |
| **การสนทนา**                | ค้นหาการสนทนาตามรหัสหรือข้อมูลติดต่อ ทำเครื่องหมายว่าอ่านแล้ว และเพิ่มหรือลบป้ายกำกับ |
| **ติดต่อ**                  | อ่าน แสดงรายการ ค้นหา และสร้างข้อมูลติดต่อ รวมถึงอัปเดต Custom Fields                 |
| **ข้อความ**                 | แสดงรายการและค้นหาข้อความของลูกค้า ส่งข้อความ อ่านและสร้างความคิดเห็นภายใน            |
| **บัญชี**                   | แสดงรายการอินบ็อกซ์ของช่องทางที่เชื่อมต่อกับร้านค้า พร้อมสถานะความพร้อมใช้งาน         |
| **ผู้ใช้ ทีม และป้ายกำกับ** | รายการแบบอ่านอย่างเดียวของที่นั่ง ทีม และป้ายกำกับ                                    |

ทุกอย่างถูกกำหนดขอบเขตไว้ที่ร้านค้าเดียว — คีย์ API จะระบุว่าร้านค้าใด จึงไม่มีพารามิเตอร์ร้านค้าในจุดใดเลย

### เริ่มต้นใช้งาน

#### 1. สร้างคีย์ API

ไปที่ **การตั้งค่า → นักพัฒนา → API Keys** ในแอป Zaapi คลิก **เพิ่มคีย์ API** ตั้งชื่อ แล้วเลือกขอบเขตการเข้าถึงที่ต้องการ

คีย์จะแสดง **เพียงครั้งเดียว** ณ ตอนสร้าง — คัดลอกก่อนปิดกล่องโต้ตอบ คีย์จะหมดอายุหลังจาก **6 เดือน**, และสามารถหมุนเวียน แก้ไข หรือลบได้ทุกเมื่อ

#### 2. ส่งคำขอ

API อยู่ที่ `https://openplatform.zaapi.co/v1`. ตรวจสอบสิทธิ์โดยส่งคีย์ผ่าน `x-api-key` เฮดเดอร์ — ไม่ต้องใช้ OAuth, bearer token หรือการรีเฟรชโทเค็น

```bash
curl https://openplatform.zaapi.co/v1/ทิกเก็ต \
  -H "x-api-key: zaapi_***"
```

ซึ่งจะแสดงคิวทิกเก็ตปัจจุบัน — ที่เปิดอยู่ ไม่อยู่ในกล่องสแปม และไม่ถูกพักการแจ้งเตือน

#### 3. อ่านเอกสารอ้างอิง

[docs.zaapi.com](https://docs.zaapi.com/) เอกสารนี้อธิบายแต่ละ endpoint พร้อมพารามิเตอร์ สคีมาของการตอบกลับ และตัวอย่างที่คัดลอกไปใช้งานได้ทันทีในหลายภาษา

### ขอบเขตสิทธิ์

คีย์จะมีเฉพาะสิทธิ์ที่กำหนดให้เท่านั้น เช่น `resource:read` และ `resource:write` เป็นคู่ — `ทิกเก็ต:read`, `contacts:write`และอื่น ๆ การเลือกสิทธิ์การเขียนจะรวมสิทธิ์การอ่านที่ตรงกันโดยอัตโนมัติ

กำหนดสิทธิ์เท่าที่จำเป็น: คีย์แบบอ่านอย่างเดียวไม่สามารถส่งข้อความถึงลูกค้าหรือปิดทิกเก็ตโดยไม่ตั้งใจได้

ดู [ขอบเขตสิทธิ์](https://docs.zaapi.com/#section/Scopes) เพื่อดูรายการทั้งหมดและดูว่าแต่ละรายการครอบคลุม endpoint ใดบ้าง

### รูปแบบที่ใช้

|                    |                                                                                                                                                 |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| **URL หลัก**       | `https://openplatform.zaapi.co/v1`                                                                                                              |
| **การยืนยันตัวตน** | `x-api-key` ส่วนหัว                                                                                                                             |
| **การแบ่งหน้า**    | อิงตาม cursor. ส่ง `pageSize` (สูงสุด 100) และ `cursor` จากการตอบกลับก่อนหน้า                                                                   |
| **การจำกัดอัตรา**  | 20 คำขอต่อวินาทีต่อเนื่อง, 40 คำขอต่อวินาทีแบบพุ่ง, 100,000 คำขอต่อวันต่อคีย์                                                                   |
| **ข้อผิดพลาด**     | รหัส HTTP มาตรฐานพร้อม JSON envelope ที่สอดคล้องกัน — `400` การตรวจสอบความถูกต้อง, `401` การยืนยันตัวตน, `403` สโคป, `404` ไม่พบ, `409` ขัดแย้ง |

รายละเอียด รวมถึงวิธีขยายเรกคอร์ดที่เกี่ยวข้องเพื่อลดการเรียก API เพิ่มเติม อยู่ใน [รูปแบบที่ใช้](https://docs.zaapi.com/#section/Conventions).

### เว็บฮุก

แทนที่จะคอยตรวจสอบการเปลี่ยนแปลงเป็นระยะ Zaapi สามารถส่ง POST ไปยังปลายทาง HTTPS ที่ควบคุมได้เมื่อมีเหตุการณ์เกิดขึ้นในร้านค้า เหตุการณ์ที่สมัครรับได้ครอบคลุมข้อความที่ได้รับและส่ง ทิกเก็ตที่เปิด เปิดใหม่ ปิด มอบหมายแล้ว และยังไม่ได้มอบหมาย การอัปเดตฟิลด์ของทิกเก็ตและข้อมูลติดต่อ และการส่งต่อไปยัง AI

ตั้งค่าได้ที่ **การตั้งค่า → นักพัฒนา → เว็บฮุก**. เว็บฮุกแต่ละรายการมี secret สำหรับลงลายเซ็น — แสดงเพียงครั้งเดียวตอนสร้าง ใช้ตรวจสอบว่าการส่งมาจาก Zaapi จริง การส่งที่ล้มเหลวจะถูกลองส่งใหม่ และบันทึกการส่งจะเก็บไว้ 7 วัน

เจ้าของร้านค้าและผู้ดูแลระบบสามารถจัดการเว็บฮุกได้ ส่วนหน้า นักพัฒนา จะไม่แสดงให้ตำแหน่งอื่น ๆ

วิธีตั้งค่าโดยละเอียด รูปแบบ payload การตรวจสอบลายเซ็น และพฤติกรรมการลองส่งใหม่: [เว็บฮุก](https://docs.zaapi.com/#section/Webhooks).

### ต้องการข้ามการเขียนโค้ดหรือไม่?

หากต้องการใช้งานข้อมูล Zaapi ผ่านผู้ช่วย AI แทนการเขียนอินทิเกรชัน การ **Zaapi MCP** เซิร์ฟเวอร์จะนำ API เดียวกันมาเชื่อมกับ Claude, Claude Code, Cursor และเครื่องมืออื่นที่รองรับ MCP — ไม่ต้องเขียนโค้ด ใช้ API key และสโคปชุดเดียวกัน

### การขอความช่วยเหลือ

* [**docs.zaapi.com**](https://docs.zaapi.com/) — เอกสารอ้างอิง API ฉบับสมบูรณ์
* [**เริ่มต้นใช้งาน**](https://docs.zaapi.com/#section/Getting-started) — การสร้างคีย์ รูปแบบคำขอ และคำอธิบายข้อผิดพลาดที่พบบ่อย
* ติดปัญหากับสิ่งที่เอกสารอ้างอิงไม่มีครอบคลุมใช่หรือไม่? ติดต่อฝ่ายสนับสนุนของ Zaapi พร้อมระบุ endpoint ที่เรียกใช้และข้อความผิดพลาดที่ได้รับกลับมา