Zum Hauptinhalt springen

Lokale API-Übersicht

TikMatrix bietet eine lokale RESTful-API, die es ermöglicht, Aufgaben programmatisch zu verwalten. Dies ist nützlich für die Integration von TikMatrix in Ihre Automatisierungssysteme, das Erstellen benutzerdefinierter Workflows oder das Durchführen von Batch-Operationen.

Anforderungen​

Lizenzanforderung

Die lokale API ist nur für Abonnenten der Pro-, Team- und Business-Pläne verfügbar. Für den Starter-Plan ist kein API-Zugriff verfügbar.

Basis-URL​

Die API läuft lokal unter:

http://localhost:50809/api/v1/
hinweis

Port 50809 ist der Standardport. Stellen Sie sicher, dass TikMatrix läuft, bevor Sie Anfragen senden.

Antwortformat​

Alle API-Antworten haben das Format:

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

Antwortcodes​

CodeBeschreibung
0Erfolg
40001Ungültige Anfrage - falsche Parameter
40002Ungültige Anfrage - fehlender script_name
40003Ungültige Anfrage - Skript wird nicht über API unterstützt
40301Verboten - API-Zugriff erfordert Pro+-Plan
40401Nicht gefunden - Ressource existiert nicht
50001Interner Serverfehler

Schnellstart​

1. API-Zugriff prüfen​

Prüfen Sie zunächst, ob Ihre Lizenz API-Zugriff unterstützt:

curl http://localhost:50809/api/v1/license/check

Beispielantwort:

{
  "code": 0,
  "message": "success",
  "data": {
    "plan_name": "Pro",
    "api_enabled": true,
    "device_limit": 20,
    "message": "API access enabled"
  }
}

2. Aufgabe erstellen​

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": "Schaut euch mein neues Video an! #viral"
    },
    "enable_multi_account": false
  }'

3. Aufgaben auflisten​

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

Verfügbare Skripte​

Aktuelle Unterstützung

Derzeit unterstützt die lokale API die Skripte post, follow, unfollow, account_warmup und comment. Unterstützung für andere Skripte wird in zukünftigen Versionen hinzugefügt.

Der Parameter script_name kann folgende Werte annehmen:

SkriptBeschreibungAPI-Unterstützung
postInhalt veröffentlichen✅ Unterstützt
followBenutzer folgen✅ Unterstützt
unfollowEntfolgen✅ Unterstützt
account_warmupAccount-Warmup✅ Unterstützt
commentKommentar hinterlassen✅ Unterstützt
likeLiken🔜 Bald
messageNachricht senden🔜 Bald
super_marketingSuper-Marketing-Kampagne🔜 Bald
profileProfil aktualisieren🔜 Bald
scrape_userBenutzerdaten sammeln🔜 Bald

Aufgabenstatus​

StatuscodeStatusBeschreibung
0pendingAufgabe wartet auf Ausführung
1runningAufgabe wird ausgeführt
2completedAufgabe erfolgreich abgeschlossen
3failedAufgabe mit Fehler beendet

Weiterführend​