RetoursObtenir l’accès API
Développeur

Développer avec l'API et les SDK

7:50 de démonstration

La narration de la vidéo est en anglais.

La Developer API de Toktik est une API REST facturée à l'usage, avec des SDK officiels — @toktikhq/sdk-js pour JavaScript/TypeScript et toktik pour Python. Commencez par le quickstart, l'authentification et les crédits, puis copiez des exemples cURL, JavaScript et Python prêts à l'emploi.

Ce que vous allez apprendre

  • Créer une clé et faire votre première requête authentifiée
  • Comprendre les scopes, les limites de débit et le modèle de crédits
  • Utiliser les SDK JavaScript et Python
  • Lire la documentation : quickstart, endpoints et scopes

Comment ça marche

  1. Créez une clé dans Settings

    Dans l'app, ouvrez Settings, puis Developer keys, et créez une clé avec uniquement les scopes dont vous avez besoin, comme rank:read pour les classements. Le secret commence par ttk_live_ et n'est affiché qu'une fois : stockez-le dans une variable d'environnement. Les clés n'accèdent qu'aux routes de données, et la création de clés reste une action réservée aux sessions connectées.

  2. Faites votre première requête

    Envoyez la clé sous la forme Authorization: Bearer avec votre secret ttk_live_. Le quickstart de la documentation appelle le classement officiel sur api.toktikhq.com/v1/rankings/official avec board=hourly et region=VN. Un 403 signifie que la clé n'a pas le scope pour cette route.

  3. Respectez les limites et les crédits

    Chaque clé a une limite de requêtes par seconde selon le plan, de 1 en Free à 150 en Agency. Au-delà, vous recevez un 429 : attendez le Retry-After et réessayez. Manquer de crédits renvoie un 402, que réessayer ne résoudra pas, et GET /v1/usage montre votre consommation.

  4. Ajoutez un SDK officiel

    Installez npm i @toktikhq/sdk-js pour JavaScript et TypeScript, ou pip install toktik pour Python ; les deux appellent la même API REST v1 avec la même clé et le même portefeuille de crédits. Les pages Docs Quickstart et API Reference listent chaque endpoint, paramètre et scope.

Questions fréquentes

Combien coûte l'API Toktik ?

Il n'y a pas de grille tarifaire d'API séparée. L'app web et l'API dépensent le même portefeuille de crédits sur le même plan. Une lecture servie depuis le stockage de Toktik coûte 1 crédit, un export coûte 2,500 crédits, et les appels de collecte à la demande coûtent plus.

Quelles sont les limites de débit de l'API Toktik ?

Par clé et par seconde : Free 1, Starter 5, Pro 20, Scale 60 et Agency 150. Des quotas quotidiens s'appliquent aussi, de 5,000 requêtes en Free à 1,200,000 en Agency. Dépasser la limite renvoie un 429 avec des en-têtes indiquant l'état de la fenêtre.

Toktik propose-t-il des SDK officiels ?

Oui. @toktikhq/sdk-js couvre JavaScript et TypeScript, et le paquet toktik couvre Python. Les deux appellent la même API REST v1 avec la même clé.

Quelle est la différence entre un 402 et un 403 de l'API Toktik ?

Un 402 signifie que l'espace de travail n'a plus de crédits : rechargez plutôt que de réessayer. Un 403 signifie que la clé est valide mais n'a pas le scope requis : accordez-le ou utilisez une session connectée. Un 429 est une limite de débit et peut être réessayé sans risque après une attente.

Lire la documentation de l'API Tous les guides

Plus dans cette section