ภาพรวม 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 | ข้อ ผิดพลาดภายในเซิร์ฟเวอร์ |
เริ่มต้นใช้งานอย่างรวดเร็ว
1) ตรวจสอบสิทธิ์การเข้าถึง API
ตรวจสอบว่าไลเซนส์ของคุณรองรับ API หรือไม่:
curl http://localhost:50809/api/v1/license/check
ตัวอย่างการตอบกลับ:
{
"code": 0,
"message": "success",
"data": {
"plan_name": "Pro",
"api_enabled": true,
"device_limit": 20,
"message": "API access enabled"
}
}
2) สร้างงาน
curl -X POST http://localhost:50809/api/v1/task \
-H "Content-Type: application/json" \
-d '{
"serials": ["device_serial_1", "device_serial_2"],
"script_name": "post",
"script_config": {
"content_type": 1,
"captions": "วิดีโอใหม่ของฉัน! #กำลังฮิต"
},
"enable_multi_account": false
}'
3) แสดงรายการงาน
curl "http://localhost:50809/api/v1/task?status=0&page=1&page_size=20"
สคริปต์ที่รองรับ
พารามิเตอร์ script_name รองรับค่าต่อไปนี้:
| ชื่อสคริปต์ | คำอธิบาย | รองรับ API |
|---|---|---|
post | โพสต์เนื้อหา | ✅ รองรับ |
follow | ติดตามผู้ใช้ | ✅ รองรับ |
unfollow | เลิกติดตามผู้ใช้ | ✅ รองรับ |
account_warmup | วอร์มบัญชี | ✅ รองรับ |
comment | แสดงความคิดเห็น | ✅ รองรับ |
boost_comment | ถูกใจ/ตอบกลับความคิดเห็นที่มีอยู่ | ✅ รองรับ |
login | เข้าสู่ระบบบัญชี | ✅ รองรับ |
profile | อัปเดตโปรไฟล์ | ✅ รองรับ |
match_account | จับคู่บัญชีในอุปกรณ ์ | ✅ รองรับ |
like | กดไลก์ | ✅ รองรับ |
view | ดูโพสต์เป็นระยะเวลาที่กำหนด | ✅ รองรับ |
favorite | บันทึกโพสต์ไปยังรายการโปรด | ✅ รองรับ |
repost | รีโพสต์วิดีโอ TikTok | ✅ รองรับ |
message | ส่งข้อความ | ✅ รองรับ |
follow_suggested | ติดตามบัญชีที่แนะนำ | ✅ รองรับ |
super_marketing | แคมเปญซุปเปอร์มาร์เก็ตติ้ง | ✅ รองรับ † |
scrape_user | ดึงข้อมูลผู้ใช้ | 🔜 เร็วๆ นี้ |
† Super Marketing ใช้ endpoint เฉพาะ
แคมเปญ Super Marketing ไม่ไ ด้ สร้างผ่าน POST /api/v1/task แต่ทำงานบนชุดข้อมูลเป้าหมายที่นำกลับมาใช้ใหม่ได้ และมี endpoint เฉพาะของตัวเอง — ดู การตั้งค่าสคริปต์ Super Marketing
สถานะงาน
| รหัสสถานะ | ข้อความสถานะ | คำอธิบาย |
|---|---|---|
| 0 | pending | งานรอการดำเนินการ |
| 1 | running | งานกำลังทำงาน |
| 2 | completed | งานสำเร็จ |
| 3 | failed | งานล้มเหลว |
อ่านต่อ
- Task Management API - สร้าง ค้นหา และจัดการงาน
- Activity Log API - ติดตามและจัดการบันทึกกิจกรรม
- การตั้งค่าสคริปต์ Post - พารามิเตอร์สคริปต์โพสต์
- การตั้งค่าสคริปต์ Follow - พารามิเตอร์สคริปต์ติดตาม
- การกำหนดค่าสคริปต์ติดตามที่แนะนำ - กำหนดค่าพารามิเตอร์สคริปต์ติดตามที่แนะนำ
- การตั้งค่าสคริปต์ Unfollow - พารามิเตอร์สคริปต์เลิกติดตาม
- การตั้งค่าสคริปต์ Account Warmup - พารามิเตอร์สคริปต์วอร์มบัญชี
- การตั้งค่าสคริปต์ Comment - พารามิเตอร์สคริปต์คอมเมนต์
- การตั้งค่าสคริปต์ Boost Comment - ถูกใจ/ตอบกลับความคิดเห็นที่มีอยู่
- การตั้งค่าสคริปต์ Like - พารามิเตอร์สคริปต์ไลก์
- การตั้งค่าสคริปต์ View - ดูโพสต์เป็นระยะเวลาที่กำหนด
- การตั้งค่าสคริปต์ Favorite - บันทึกโพสต์ไปยังรายการโปรด
- การตั้งค่าสคริปต์ Message - พารามิเตอร์สคริปต์ข้อความ
- การตั้งค่าสคริปต์ Login - พารามิเตอร์สคริปต์เข้าสู่ระบบ
- การตั้งค่าสคริปต์ Profile - พารามิเตอร์สคริปต์โปรไฟล์
- การตั้งค่าสคริปต์ Match Account - พารามิเตอร์สคริปต์จับคู่บัญชี
- การตั้งค่าสคริปต์ Super Marketing - นำเข้าชุดข้อมูลเป้าหมายและเปิดตัวแคมเปญ
- API สแกน TCP - สแกนและเชื่อมต่ออุปกรณ์ Android ผ่าน TCP/IP
- API สถานะบัญชี - ตรวจสอบสถานะบัญชี การเชื่อมต่ออุปกรณ์ และสถานะการเข้าสู่ระบบ
- ตัวอย่าง API - ตัวอย่างโค้ดในหลายภาษา