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 - Script non pris en charge ou état de tâche invalide
40004Erreur de paramètre - Seules les tâches en cours d'exécution peuvent être arrêtées
40005Erreur de paramètre - task_ids ne peut pas être vide
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​

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
commentPublier un commentaire sur des posts✅ Pris en charge
boost_commentAimer/répondre aux commentaires existants✅ Pris en charge
loginSe connecter au compte✅ Pris en charge
profileMettre à jour le profil✅ Pris en charge
match_accountAssocier les comptes sur l'appareil✅ Pris en charge
likeAimer des posts✅ Pris en charge
viewRegarder une publication pendant une durée✅ Pris en charge
favoriteEnregistrer une publication dans les Favoris✅ Pris en charge
repostRepartager des vidéos TikTok✅ Pris en charge
messageMessage privé✅ Pris en charge
follow_suggestedSuivre les comptes suggérés✅ Pris en charge
super_marketingCampagne de super marketing✅ Pris en charge †
scrape_userExtraire les données utilisateur🔜 Prochainement
† Le super marketing utilise des endpoints dédiés

La campagne de super marketing n'est pas créée via POST /api/v1/task. Elle fonctionne sur un dataset réutilisable de cibles et dispose de ses propres endpoints — voir la Configuration du Script Super Marketing.

É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​