getBalance : consulter le solde

getBalance renvoie les points restants du compte (1,000 points = ¥1) ainsi que les soldes de part développeur et de récompense de parrainage (en yuans). Il n’y a aucun débit de points ; cette méthode sert souvent à vérifier qu’un clientKey est correct.

POSThttps://api.yescaptcha.com/getBalanceEndpoint mondialCopier

POSThttps://cn.yescaptcha.com/getBalanceEndpoint ChineCopier

Paramètres de la requête

Champ	Type	Obligatoire	Description
clientKey	string	Oui	Clé du compte

{
  "clientKey": "YOUR_CLIENT_KEY"
}

Réponse

{
  "errorId": 0,
  "balance": 1071810,
  "softBalance": 36.0098,
  "inviteBalance": 0,
  "inviteBy": 0
}

Champ	Type	Description
balance	integer	Solde du compte, en points (1,000 points = ¥1). Il doit être supérieur à 10 points pour créer une tâche
softBalance	number	Solde de la part développeur, en yuans ; voir Part développeur
inviteBalance	number	Solde des récompenses de parrainage, en yuans ; voir Récompense de parrainage
inviteBy	integer	ID utilisateur de la personne qui vous a invité, 0 s’il n’y en a pas
keyQuotaRemaining	integer	Limite de dépenses restante de ce clientKey pour la période en cours, en points. Ce champ n’existe que pour un clientKey ayant une limite ; balance est alors la plus petite valeur entre le solde du compte et la limite restante. Il est absent pour un clientKey sans limite

Un clientKey incorrect renvoie ERROR_KEY_DOES_NOT_EXIST ; si le clientKey a une liste blanche d’IP et que la requête provient d’une IP absente de cette liste, la réponse est ERROR_KEY_IP_NOT_ALLOWED. getBalance est soumis à la suspension automatique : pendant une suspension, il renvoie ERROR_IP_BLOCKED_5MIN.

Exemples

curl

get-balance.sh

#!/usr/bin/env bash
# Check the balance. getBalance is free and is a quick way to verify your clientKey
set -euo pipefail
curl -s https://api.yescaptcha.com/getBalance \
  -H 'Content-Type: application/json' \
  -d "{\"clientKey\": \"${YESCAPTCHA_CLIENT_KEY}\"}"
echo

Python

get_balance.py

"""Check the balance. getBalance is free and is a quick way to verify your clientKey."""
import os

import requests

CLIENT_KEY = os.environ["YESCAPTCHA_CLIENT_KEY"]

r = requests.post(
    "https://api.yescaptcha.com/getBalance",
    json={"clientKey": CLIENT_KEY},
    timeout=30,
)
data = r.json()
if data.get("errorId"):
    # e.g. ERROR_KEY_DOES_NOT_EXIST when the clientKey is wrong
    print("error:", data.get("errorCode"), data.get("errorDescription"))
else:
    print("balance (points):", data["balance"])

Node.js

get-balance.mjs

// Check the balance. getBalance is free and is a quick way to verify your clientKey. Node.js 18+
const CLIENT_KEY = process.env.YESCAPTCHA_CLIENT_KEY;

const res = await fetch('https://api.yescaptcha.com/getBalance', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ clientKey: CLIENT_KEY }),
});
const data = await res.json();
if (data.errorId) {
  // e.g. ERROR_KEY_DOES_NOT_EXIST when the clientKey is wrong
  console.log('error:', data.errorCode, data.errorDescription);
} else {
  console.log('balance (points):', data.balance);
}