Обзор локального 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	Неверный запрос - скрипт не поддерживается через API
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,
    "min_interval": 1,
    "max_interval": 5
  }'

3. Получение списка задач

curl http://localhost:50809/api/v1/task?status=0&page=1&page_size=20

Доступные скрипты

Текущая поддержка

В настоящее время локальное API поддерживает только скрипт post. Поддержка других скриптов будет добавлена в будущих версиях.

Параметр script_name может принимать следующие значения:

Скрипт	Описание	Поддержка API
post	Опубликовать контент	✅ Поддерживается
follow	Подписаться на пользователя	🔜 Скоро
unfollow	Отписаться	🔜 Скоро
like	Поставить лайк	🔜 Скоро
comment	Оставить комментарий	🔜 Скоро
message	Отправить сообщение	🔜 Скоро
account_warmup	Разогрев аккаунта	🔜 Скоро
super_marketing	Супер маркетинговая кампания	🔜 Скоро
profile	Обновить профиль	🔜 Скоро
scrape_user	Собирать данные о пользователе	🔜 Скоро

Статус задачи

Код статуса	Статус	Описание
0	pending	Задача ожидает выполнения
1	running	Задача выполняется
2	completed	Задача выполнена успешно
3	failed	Задача завершилась с ошибкой

Дальше

• API управления задачами - создание, запрос и управление задачами
• Примеры API - примеры кода на нескольких языках