Chuyển tới nội dung chính

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​

CodeMô tả
0Thành công
40001Lỗi tham số - tham số request không hợp lệ
40002Lỗi tham số - thiếu script_name
40003Lỗi tham số - script không được hỗ trợ hoặc trạng thái task không hợp lệ
40004Lỗi tham số - chỉ có thể dừng các task đang chạy
40005Lỗi tham số - task_ids không thể trống
40301Forbidden - cần gói Pro+ để dùng API
40401Not found - tài nguyên không tồn tại
50001Lỗ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​

script_name chấp nhận các giá trị sau:

Tên scriptMô tảHỗ trợ API
postĐăng nội dung✅ Được hỗ trợ
followTheo dõi người dùng✅ Được hỗ trợ
unfollowBỏ theo dõi người dùng✅ Được hỗ trợ
account_warmupLàm ấm tài khoản✅ Được hỗ trợ
commentBình luận✅ Được hỗ trợ
boost_commentThích / trả lời các bình luận hiện có✅ Được hỗ trợ
loginĐăng nhập tài khoản✅ Được hỗ trợ
profileCập nhật hồ sơ✅ Được hỗ trợ
match_accountGhép tài khoản trên thiết bị✅ Được hỗ trợ
likeThả tim✅ Được hỗ trợ
viewXem bài đăng trong một khoảng thời gian✅ Được hỗ trợ
favoriteLưu bài đăng vào Yêu thích✅ Được hỗ trợ
repostĐăng lại video TikTok✅ Được hỗ trợ
messageGửi tin nhắn✅ Được hỗ trợ
follow_suggestedTheo dõi tài khoản gợi ý✅ Được hỗ trợ
super_marketingChiến dịch siêu marketing✅ Được hỗ trợ †
scrape_userThu thập dữ liệu người dùng🔜 Sắp ra mắt
† Super marketing dùng endpoint riêng

Chiến dịch super marketing không được tạo qua POST /api/v1/task. Nó chạy dựa trên tập dữ liệu mục tiêu có thể tái sử dụng và có các endpoint riêng — xem Cấu hình Script Super Marketing.

Trạng thái task​

Mã trạng tháiVăn bản trạng tháiMô tả
0pendingTask đang chờ chạy
1runningTask đang chạy
2completedTask chạy thành công
3failedTask chạy thất bại

Xem thêm​