Skip to main content
GET
Obtenez le solde restant et le solde utilisé de la clé API (token) actuelle. Cet endpoint sert à surveiller l’utilisation d’un seul token.

Autorisation

string
requis
Tous les endpoints API requièrent une authentification par Bearer TokenObtenez votre clé API :Rendez-vous sur la page de gestion des clés API pour obtenir votre clé APIAjoutez-la à l’en-tête de la requête :

Endpoints

Les deux endpoints offrent les mêmes fonctionnalités ; vous pouvez utiliser l’un ou l’autre.

Réponse

boolean
Indique si la requête a réussi
string
Message d’erreur (renvoyé uniquement en cas d’échec)
float
Solde restant du token (renvoyé en cas de succès). Renvoie -1 lorsque unlimited_quota vaut true
integer
Crédits restants du token (renvoyé en cas de succès). Renvoie -1 lorsque unlimited_quota vaut true
float
Solde utilisé du token (renvoyé en cas de succès)
integer
Crédits utilisés du token (renvoyé en cas de succès)
boolean
Indique si le token dispose d’un quota illimité. true signifie illimité, false signifie limité

Cas d’usage

  • Surveiller la consommation d’une seule clé API
  • Afficher le solde actuel du token dans votre application
  • Configurer des alertes lorsque le solde passe sous un seuil
Informations sur l’unité du soldeL’unité de la valeur du solde dépend de la configuration du système :
  • USD — Dollars américains
  • Credits — Crédits
Token à quota illimitéLorsqu’un token est configuré avec un quota illimité :
  • Le champ unlimited_quota renvoie true
  • Le champ remain_balance renvoie -1
  • Le champ remain_credits renvoie -1
  • Le token n’a aucune restriction de quota et peut être utilisé sans limite

Erreurs fréquentes

Note de sécuritéVotre clé API est comme un mot de passe. Conservez-la en sécurité et ne la partagez pas. Utilisez toujours HTTPS en production.