Przejdź do głównej zawartości

Przegląd Local API

TikMatrix zapewnia lokalne RESTful API, które pozwala na programowe zarządzanie zadaniami. Jest to przydatne do integracji TikMatrix z własnymi systemami automatyzacji, tworzenia niestandardowych przepływów pracy lub wykonywania operacji wsadowych.

Wymagania​

Wymaganie licencji

Local API jest dostępne tylko dla subskrybentów planów Pro, Team i Business. Plan Starter nie ma dostępu do API.

Bazowy URL​

API działa na twoim lokalnym komputerze pod adresem:

http://localhost:50809/api/v1/
notatka

Port 50809 jest domyślnym portem. Upewnij się, że TikMatrix jest uruchomiony przed wykonywaniem żądań API.

Format odpowiedzi​

Wszystkie odpowiedzi API mają następujący format:

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

Kody odpowiedzi​

KodOpis
0Sukces
40001Złe żądanie - Nieprawidłowe parametry
40002Złe żądanie - Brak script_name
40003Złe żądanie - Skrypt nieobsługiwany przez API
40301Zabronione - Dostęp do API wymaga planu Pro+
40401Nie znaleziono - Zasób nie znaleziony
50001Wewnętrzny błąd serwera

Szybki start​

1. Sprawdź dostęp do API​

Najpierw sprawdź, czy twoja licencja obsługuje dostęp do API:

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

Odpowiedź:

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

2. Utwórz zadanie​

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": "Check out my new video! #viral"
    },
    "enable_multi_account": false,
    "start_time": "14:30"
  }'

3. Wyświetl zadania​

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

Dostępne skrypty​

Parametr script_name akceptuje następujące wartości:

Nazwa skryptuOpisWsparcie API
postPublikowanie treści✅ Obsługiwane
followObserwowanie użytkowników✅ Obsługiwane
unfollowZaprzestanie obserwacji użytkowników✅ Obsługiwane
account_warmupRozgrzewanie kont✅ Obsługiwane
commentKomentowanie postów✅ Obsługiwane
likePolubienia postów🔜 Wkrótce
messageWysyłanie wiadomości bezpośrednich🔜 Wkrótce
super_marketingKampania super marketingowa🔜 Wkrótce
profileAktualizacja profilu🔜 Wkrótce
scrape_userZbieranie danych użytkownika🔜 Wkrótce

Status zadania​

Kod statusuTekst statusuOpis
0pendingZadanie oczekuje na wykonanie
1runningZadanie jest obecnie wykonywane
2completedZadanie zakończone pomyślnie
3failedZadanie nie powiodło się

Następne kroki​