Hoppa till huvudinnehåll

Översikt över lokalt API

TikMatrix tillhandahåller ett lokalt RESTful API som gör det möjligt att hantera uppgifter programmatiskt. Detta är användbart för att integrera TikMatrix med dina egna automationssystem, bygga anpassade arbetsflöden eller skapa batch-operationer.

Krav

Licenskrav

Det lokala API:et är endast tillgängligt för Pro, Team och Business-prenumeranter. Starter-planen har inte tillgång till API:et.

Bas-URL

API:et körs på din lokala maskin på:

http://localhost:50809/api/v1/
anteckning

Porten 50809 är standardporten. Se till att TikMatrix körs innan du gör API-förfrågningar.

Svarsformat

Alla API-svar följer detta format:

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

Svarskoder

KodBeskrivning
0Framgång
40001Felaktig begäran - Ogiltiga parametrar
40002Felaktig begäran - Saknar script_name
40003Felaktig begäran - Script stöds inte via API
40301Förbjuden - API-åtkomst kräver Pro+ plan
40401Hittades inte - Resurs hittades inte
50001Internt serverfel

Snabbstart

1. Kontrollera API-åtkomst

Först, verifiera att din licens stöder API-åtkomst:

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

Svar:

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

2. Skapa en uppgift

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. Lista uppgifter

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

Tillgängliga scripts

Parametern script_name accepterar följande värden:

Script-namnBeskrivningAPI-stöd
postPublicera innehåll✅ Stöds
followFölj användare✅ Stöds
unfollowSluta följa användare✅ Stöds
account_warmupVärm upp konton✅ Stöds
commentKommentera inlägg✅ Stöds
likeGilla inlägg🔜 Kommer snart
messageSkicka direktmeddelanden🔜 Kommer snart
super_marketingSupermarknadsföringskampanj🔜 Kommer snart
profileUppdatera profil🔜 Kommer snart
scrape_userSkrapa användardata🔜 Kommer snart

Uppgiftsstatus

StatuskodStatustextBeskrivning
0pendingUppgiften väntar på att utföras
1runningUppgiften körs för närvarande
2completedUppgiften slutfördes framgångsrikt
3failedUppgiften misslyckades

Nästa steg