メインコンテンツまでスキップ

ローカル API 概要

TikMatrix は、プログラム的にタスクを管理できるローカル RESTful API を提供します。これは、TikMatrix を独自の自動化システムと統合したり、カスタムワークフローを構築したり、バッチ操作を作成したりするのに便利です。

要件​

ライセンス要件

ローカル API は Pro、Team、Business プランのサブスクライバーのみが利用できます。 Starter プランには API へのアクセスがありません。

ベース URL​

API はローカルマシン上で実行されます：

http://localhost:50809/api/v1/
注記

ポート 50809 はデフォルトポートです。API リクエストを行う前に TikMatrix が実行されていることを確認してください。

レスポンス形式​

すべての API レスポンスは次の形式に従います：

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

レスポンスコード​

コード説明
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投稿をお気に入りに保存✅ サポート済み
repostTikTok動画をリポスト✅ サポート済み
messageダイレクトメッセージを送信✅ サポート済み
follow_suggestedおすすめアカウントをフォロー✅ サポート済み
super_marketingスーパーマーケティングキャンペーン✅ サポート済み †
scrape_userユーザーデータをスクレイピング🔜 近日公開
† スーパーマーケティングは専用エンドポイントを使用

スーパーマーケティングキャンペーンは POST /api/v1/task では作成しません。再利用可能なターゲットデータセットを基に動作し、専用のエンドポイントが用意されています — スーパーマーケティングスクリプト設定を参照してください。

タスクステータス​

ステータスコードステータステキスト説明
0pendingタスクは実行待ち
1runningタスクは現在実行中
2completedタスクは正常に完了
3failedタスクは失敗

次のステップ​