Перейти к основному содержимому

Обзор локального 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Задача завершилась с ошибкой

Дальше​