Перейти до основного вмісту

Огляд локального API

TikMatrix надає локальний RESTful API, що дозволяє програмно керувати завданнями. Це корисно для інтеграції TikMatrix у власні системи автоматизації, побудови кастомних робочих процесів або виконання пакетних операцій.

Вимоги​

Вимоги до ліцензії

Локальний API доступний лише для підписників планів Pro, Team і Business. Для плану Starter доступ до API відсутній.

Базова URL-адреса​

API працює локально за адресою:

http://localhost:50809/api/v1/
примітка

Порт 50809 — порт за замовчуванням. Переконайтеся, що TikMatrix запущено перед надсиланням запитів.

Формат відповіді​

Усі відповіді API мають формат:

{
  "code": 0,
  "message": "success",
  "data": { ... }
}

Коди відповідей​

CodeОпис
0Успіх
40001Неправильний запит - невірні параметри
40002Неправильний запит - відсутній script_name
40003Неправильний запит - скрипт не підтримується або невірний стан завдання
40004Неправильний запит - можна зупинити лише запущені завдання
40005Неправильний запит - task_ids не можна залишати порожнім
40301Заборонено - доступ до API потребує план Pro+
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,
    "start_time": "14:30"
  }'

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Збирати дані користувачів🔜 Незабаром
† Супер-маркетинг використовує окремі ендпоінти

Кампанія супер-маркетингу не створюється через POST /api/v1/task. Вона працює на основі датасету цілей і має власні ендпоінти — див. Конфігурацію скрипту супер-маркетингу.

Статус завдання​

Код статусуСтатусОпис
0pendingЗавдання очікує виконання
1runningЗавдання виконується
2completedЗавдання виконано успішно
3failedЗавдання завершилося з помилкою

Далі​