Aller au contenu principal

Aperçu de l'API Locale

TikMatrix fournit une API RESTful locale qui vous permet de gérer les tâches par programmation. Cela est particulièrement utile pour intégrer TikMatrix dans vos propres systèmes d'automatisation, créer des flux de travail personnalisés ou effectuer des opérations en masse.

Exigences

Exigences de licence

L'API locale est disponible uniquement pour les utilisateurs des forfaits Pro, Team et Business. Le forfait Starter ne fournit pas d'accès à l'API.

URL de Base

L'API fonctionne localement à l'adresse :

http://localhost:50809/api/v1/
remarque

Le port 50809 est le port par défaut. Veuillez vous assurer que TikMatrix est en cours d'exécution avant d'envoyer des requêtes.

Format de Réponse

Toutes les réponses de l'API suivent le format suivant :

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

Description des Codes de Réponse

CodeDescription
0Succès
40001Erreur de paramètre - Paramètres de requête invalides
40002Erreur de paramètre - script_name manquant
40003Erreur de paramètre - Le script ne prend pas encore en charge les appels API
40301Interdit - L'accès à l'API nécessite un forfait Pro+
40401Non trouvé - La ressource n'existe pas
50001Erreur interne du serveur

Démarrage Rapide

1. Vérifier l'Accès à l'API

Tout d'abord, confirmez que votre licence prend en charge l'API :

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

Exemple de réponse :

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

2. Créer une Tâche

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": "Regardez ma nouvelle vidéo ! #tendance"
},
"enable_multi_account": false
}'

3. Interroger la Liste des Tâches

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

Scripts Disponibles

Support Actuel

Actuellement, l'API locale prend en charge les scripts post, follow, unfollow, account_warmup et comment. D'autres scripts seront ajoutés progressivement dans les versions futures.

Le paramètre script_name accepte les valeurs suivantes :

Nom du ScriptDescriptionSupport API
postPublier du contenu✅ Pris en charge
followSuivre des utilisateurs✅ Pris en charge
unfollowSe désabonner✅ Pris en charge
account_warmupPréchauffage de compte✅ Pris en charge
commentCommenter✅ Pris en charge
likeAimer🔜 Prochainement
messageMessage privé🔜 Prochainement
super_marketingCampagne de super marketing🔜 Prochainement
profileMettre à jour le profil🔜 Prochainement
scrape_userExtraire les données utilisateur🔜 Prochainement

États des Tâches

Code d'ÉtatTexte d'ÉtatDescription
0pendingLa tâche est en attente d'exécution
1runningLa tâche est en cours d'exécution
2completedLa tâche a été exécutée avec succès
3failedL'exécution de la tâche a échoué

Suite