Solde du compte

Retourne le solde du portefeuille associé à la clé. À surveiller dans vos applications : un solde nul provoque des 402 sur les appels facturés suivants ; la lecture du solde et la liste des modèles restent possibles.

Requête#

curl https://api.cloudzir.com/v1/user/balance \
  -H "Authorization: Bearer $CLOUDZIR_API_KEY"

import httpx

r = httpx.get(
    "https://api.cloudzir.com/v1/user/balance",
    headers={"Authorization": f"Bearer {cle}"},
    timeout=20,
)
info = r.json()["balance_infos"][0]
solde = float(info["total_balance"])
if solde < 500:
    alerter(f"Solde CloudZIR bas : {solde:.2f} DA")

const r = await fetch("https://api.cloudzir.com/v1/user/balance", {
  headers: { Authorization: `Bearer ${cle}` },
});
const { balance_infos } = await r.json();
const solde = Number(balance_infos[0].total_balance);
if (solde < 500) alerter(`Solde CloudZIR bas : ${solde.toFixed(2)} DA`);

Réponse#

{
  "object": "user.balance",
  "is_available": true,
  "balance_infos": [
    {
      "currency": "DZD",
      "total_balance": "4820.5000"
    }
  ]
}

Surveiller son solde#

Cet appel ne consomme aucun jeton et fonctionne même à solde nul. Deux usages recommandés :

• Sonde périodique (toutes les heures) qui alerte sous un seuil, bien plus confortable que de découvrir un 402 en production.
• Sur 402 : interroger le solde pour distinguer « compte vide » d'un autre problème, et afficher un message clair à vos équipes.

SEUIL_DA = 500

def verifier_solde(cle: str) -> None:
    r = httpx.get("https://api.cloudzir.com/v1/user/balance",
                  headers={"Authorization": f"Bearer {cle}"}, timeout=20)
    r.raise_for_status()
    info = r.json()["balance_infos"][0]
    solde = float(info["total_balance"])
    if solde <= 0:
        alerter("CRITIQUE : portefeuille CloudZIR vide, les appels échouent en 402")
    elif solde < SEUIL_DA:
        alerter(f"Solde CloudZIR bas : {solde:.2f} DA - penser à recharger")

Recharger#

Depuis plateforme.cloudzir.com/topup : les moyens de paiement proposés apparaissent sur la page Top up de la plateforme. Le crédit intervient après vérification pour les versements manuels. Aucune action technique n'est nécessaire ensuite : les appels repartent dès que le solde est positif.