ภาพรวม Local API
TikMatrix มี Local RESTful API ที่ช่วยให้คุณจัดการงานผ่านโปรแกรมได้ เหมาะสำหรับการเชื่อม TikMatrix เข้ากับระบบอัตโนมัติของคุณเอง การทำเวิร์กโฟลว์เฉพาะทาง หรือการทำงานแบบแบตช์
ข้อกำหนด
ข้อกำหนดด้านไลเซนส์
Local API เปิดให้ใช้งานเฉพาะผู้ใช้แผน Pro, Team และ Business เท่านั้น แผน Starter จะไม่สามารถเข้าถึง API ได้
Base URL
API ทำงานบนเครื่องโลคัลที่:
http://localhost:50809/api/v1/
note
พอร์ต 50809 คือพอร์ตเริ่มต้น โปรดตรวจสอบว่า TikMatrix กำลังทำงานก่อนเรียก API
รูปแบบการตอบกลับ
การตอบกลับของ API ทั้งหมดใช้รูปแบบเดียวกัน:
{
"code": 0,
"message": "success",
"data": { ... }
}
คำอธิบายรหัสตอบกลับ
| Code | คำอธิบาย |
|---|---|
| 0 | สำเร็จ |
| 40001 | พารามิเตอร์ไม่ถูกต้อง |
| 40002 | พารามิเตอร์ไม่ครบ - ขาด script_name |
| 40003 | พารามิเตอร์ไม่ถูกต้อง - สคริปต์ไม่ได้รับการสนับสนุนหรือสถานะงานไม่ถูกต้อง |
| 40004 | พารามิเตอร์ไม่ถูกต้อง - สามารถหยุดเฉพาะงานที่กำลังทำงาน |
| 40005 | พารามิเตอร์ไม่ถูกต้อง - task_ids ไม่สามารถเว้นว่างได้ |
| 40301 | ถูกปฏิเสธ - ต้องใช้แผน Pro+ เพื่อเข้าถึง API |
| 40401 | ไม่พบทรัพยากร |
| 50001 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ |