Tổng quan Local API
TikMatrix cung cấp một Local RESTful API, cho phép bạn quản lý task bằng lập trình. Điều này rất hữu ích khi tích hợp TikMatrix vào hệ thống tự động hóa riêng, xây dựng workflow tùy chỉnh, hoặc xử lý hàng loạt.
Yêu cầu
Yêu cầu giấy phép
Local API chỉ mở cho người dùng gói Pro, Team và Business. Gói Starter không có quyền truy cập API.
Base URL
API chạy trên máy cục bộ tại:
http://localhost:50809/api/v1/
ghi chú
Cổng mặc định là 50809. Hãy đảm bảo TikMatrix đang chạy trước khi gọi API.
Định dạng phản hồi
Tất cả phản hồi API dùng cùng cấu trúc:
{
"code": 0,
"message": "success",
"data": { ... }
}
Mã phản hồi
| Code | Mô tả |
|---|---|
| 0 | Thành công |
| 40001 | Lỗi tham số - tham số request không hợp lệ |
| 40002 | Lỗi tham số - thiếu script_name |
| 40003 | Lỗi tham số - script chưa hỗ trợ gọi qua API |
| 40301 | Forbidden - cần gói Pro+ để dùng API |
| 40401 | Not found - tài nguyên không tồn tại |
| 50001 | Lỗi nội bộ máy chủ |
Bắt đầu nhanh
1) Kiểm tra quyền truy cập API
curl http://localhost:50809/api/v1/license/check
Ví dụ phản hồi:
{
"code": 0,
"message": "success",
"data": {
"plan_name": "Pro",
"api_enabled": true,
"device_limit": 20,
"message": "API access enabled"
}
}
2) Tạo task
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": "Xem video mới của mình nhé! #trend"
},
"enable_multi_account": false
}'
3) Liệt kê task
curl "http://localhost:50809/api/v1/task?status=0&page=1&page_size=20"
Các script khả dụng
Hỗ trợ hiện tại
Hiện tại Local API hỗ trợ các script post, follow, unfollow, account_warmup và comment. Các script khác sẽ được bổ sung ở các phiên bản sau.
script_name chấp nhận các giá trị sau:
| Tên script | Mô tả | Hỗ trợ API |
|---|---|---|
post | Đăng nội dung | ✅ Hỗ trợ |
follow | Theo dõi người dùng | ✅ Hỗ trợ |
unfollow | Bỏ theo dõi người dùng | ✅ Hỗ trợ |
account_warmup | Làm ấm tài khoản | ✅ Hỗ trợ |
comment | Bình luận | ✅ Hỗ trợ |
login | Đăng nhập tài khoản | ✅ Hỗ trợ |
profile | Cập nhật hồ sơ | ✅ Hỗ trợ |
match_account | Ghép tài khoản trên thiết bị | ✅ Hỗ trợ |
like | Thả tim | ✅ Hỗ trợ |
message | Gửi tin nhắn | ✅ Hỗ trợ |
super_marketing | Chiến dịch marketing nâng cao | 🔜 Sắp ra mắt |
scrape_user | Thu thập dữ liệu người dùng | 🔜 Sắp ra mắt |
Trạng thái task
| Mã trạng thái | Văn bản trạng thái | Mô tả |
|---|---|---|
| 0 | pending | Task đang chờ chạy |
| 1 | running | Task đang chạy |
| 2 | completed | Task chạy thành công |
| 3 | failed | Task chạy thất bại |
Xem thêm
- Task Management API - Tạo, truy vấn và quản lý task
- Activity Log API - Theo dõi và quản lý nhật ký hoạt động
- Cấu hình script Post - Tham số script đăng bài
- Cấu hình script Follow - Tham số script theo dõi
- Cấu hình script Unfollow - Tham số script bỏ theo dõi
- Cấu hình script Account Warmup - Tham số script làm ấm tài khoản
- Cấu hình script Comment - Tham số script bình luận
- Cấu hình script Like - Tham số script thả tim
- Cấu hình script Message - Tham số script nhắn tin
- Cấu hình script Login - Tham số script đăng nhập
- Cấu hình script Profile - Tham số script hồ sơ
- Cấu hình script Match Account - Tham số script ghép tài khoản
- Ví dụ API - Ví dụ code cho nhiều ngôn ngữ