Consulter le solde de l'utilisateur

Obtenez le solde restant et le solde utilisé du compte utilisateur actuel. Cet endpoint renvoie les informations de solde au niveau utilisateur, indépendamment des tokens spécifiques, afin de consulter le solde global du compte.

curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}

Autorisation

Authorization

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 :

Authorization: Bearer YOUR_API_KEY

Endpoints

GET /v1/user/balance
GET /user/balance

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

Réponse

success

boolean

Indique si la requête a réussi

message

string

Message d’erreur (renvoyé uniquement en cas d’échec)

remain_balance

float

Solde restant de l’utilisateur (renvoyé en cas de succès). Renvoie -1 lorsque unlimited_quota vaut true

used_balance

float

Solde utilisé de l’utilisateur (renvoyé en cas de succès)

unlimited_quota

boolean

Indique si l’utilisateur dispose d’un quota illimité. true signifie illimité, false signifie limité

Solde du token vs solde utilisateur

Comparaison	Solde du token (`/v1/balance`)	Solde utilisateur (`/v1/user/balance`)
Portée	Un seul token	Compte utilisateur complet
Source des données	RemainQuota et UsedQuota du token	quota et used_quota de l’utilisateur
Cas d’usage	Surveiller l’utilisation d’une clé API	Consulter le solde global du compte
Limité par	Limites de quota au niveau du token	Limites de quota au niveau utilisateur

Cas d’usage

Consulter le solde global du compte utilisateur
Configurer des rappels de recharge et des alertes de solde
Afficher le solde du compte dans le tableau de bord utilisateur

Informations sur l’unité du soldeL’unité de la valeur du solde dépend de la configuration du système :

USD — Dollars américains
CNY — Yuans chinois
Tokens — Nombre de tokens

Utilisateur à quota illimitéLorsqu’un utilisateur est configuré avec un quota illimité :

Le champ unlimited_quota renvoie true
Le champ remain_balance renvoie -1
L’utilisateur n’a aucune restriction de quota et peut utiliser l’API sans limite

Erreurs fréquentes

Message d’erreur	Cause	Solution
No Authorization header	En-tête Authorization non fourni	Ajoutez l’en-tête `Authorization: Bearer sk-xxxxx`
Failed to get user quota	L’utilisateur n’existe pas	Vérifiez que l’utilisateur associé au token existe
Failed to get used quota	Erreur de requête en base de données	Contactez l’administrateur pour vérifier l’état du système

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.

Documentation Index

​Autorisation

​Endpoints

​Réponse

​Solde du token vs solde utilisateur

​Cas d’usage