Ga naar hoofdinhoud

Local API Overzicht

TikMatrix biedt een lokale RESTful API waarmee u taken programmatisch kunt beheren. Dit is handig voor het integreren van TikMatrix met uw eigen automatiseringssystemen, het bouwen van aangepaste workflows of het maken van batchbewerkingen.

Vereisten

Licentie Vereiste

De Local API is alleen beschikbaar voor Pro, Team en Business plan abonnees. Het Starter plan heeft geen toegang tot de API.

Basis URL

De API draait op uw lokale machine op:

http://localhost:50809/api/v1/
notitie

De poort 50809 is de standaard poort. Zorg ervoor dat TikMatrix draait voordat u API verzoeken doet.

Response Formaat

Alle API responses volgen dit formaat:

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

Response Codes

CodeBeschrijving
0Succes
40001Bad Request - Ongeldige parameters
40002Bad Request - Ontbrekende script_name
40003Bad Request - Script niet ondersteund via API
40301Forbidden - API toegang vereist Pro+ plan
40401Not Found - Resource niet gevonden
50001Internal Server Error

Snelstart

1. Controleer API Toegang

Controleer eerst of uw licentie API toegang ondersteunt:

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

Response:

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

2. Maak een Taak

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. Lijst Taken

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

Beschikbare Scripts

De script_name parameter accepteert de volgende waarden:

Script NaamBeschrijvingAPI Ondersteuning
postPubliceer inhoud✅ Ondersteund
followVolg gebruikers✅ Ondersteund
unfollowOntvolg gebruikers✅ Ondersteund
account_warmupWarm accounts op✅ Ondersteund
commentReageer op posts✅ Ondersteund
likeLike posts🔜 Binnenkort
messageStuur directe berichten🔜 Binnenkort
super_marketingSuper marketing campagne🔜 Binnenkort
profileUpdate profiel🔜 Binnenkort
scrape_userScrape gebruikersgegevens🔜 Binnenkort

Taak Status

Status CodeStatus TekstBeschrijving
0pendingTaak wacht om uitgevoerd te worden
1runningTaak wordt momenteel uitgevoerd
2completedTaak succesvol voltooid
3failedTaak mislukt

Volgende Stappen