getBalance — Bakiye sorgulama

getBalance, hesabınızdaki kalan puanı (1,000 puan = ¥1) ile geliştirici gelir payı ve davet ödülü bakiyelerini (¥ cinsinden) döndürür. Puan düşümü yapmaz; bu yüzden clientKey değerinin doğru olup olmadığını kontrol etmek için sıkça kullanılır.

POSThttps://api.yescaptcha.com/getBalanceGlobal uç noktaKopyala

POSThttps://cn.yescaptcha.com/getBalanceÇin uç noktasıKopyala

İstek parametreleri

Alan	Tür	Zorunlu	Açıklama
clientKey	string	Evet	ClientKey (hesap anahtarınız)

{
  "clientKey": "YOUR_CLIENT_KEY"
}

Dönen sonuç

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

Alan	Tür	Açıklama
balance	integer	Hesap bakiyesi, birimi puandır (1,000 puan = ¥1). Görev oluşturabilmek için 10 puandan fazla olmalıdır
softBalance	number	Geliştirici gelir payı bakiyesi, birimi ¥’dir. Bkz. Geliştirici gelir payı
inviteBalance	number	Davet ödülü bakiyesi, birimi ¥’dir. Bkz. Davet ödülü
inviteBy	integer	Sizi davet eden kişinin kullanıcı ID’si; yoksa 0
keyQuotaRemaining	integer	Bu clientKey için mevcut dönemde kalan harcama limiti, birimi puandır. Yalnızca limit tanımlanmış clientKey değerlerinde bulunur; bu durumda balance, hesap bakiyesi ile kalan limitten küçük olanıdır. Limit tanımlanmamış clientKey değerlerinde bu alan yer almaz

clientKey yanlışsa ERROR_KEY_DOES_NOT_EXIST döner; clientKey için IP beyaz listesi tanımlıysa ve istek listede olmayan bir IP’den gelirse ERROR_KEY_IP_NOT_ALLOWED döner. getBalance, otomatik duraklatmadan etkilenir: duraklatma süresince ERROR_IP_BLOCKED_5MIN döner.

Örnekler

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);
}