Методы API

API баланса баллов

GET /open/v1/balance возвращает текущий баланс баллов аккаунта, которому принадлежит API-ключ. Баланс общий с сайтом — удобно для проверки перед отправкой задач.

На этой странице

Получение баланса

http
GET /open/v1/balance

Возвращает текущее количество доступных баллов на аккаунте, которому принадлежит API-ключ. API и сайт используют один общий баланс баллов.

curl https://api.zroimg.com/open/v1/balance \
  -H "Authorization: Bearer zk-xxxxxxxxxxxxxxxxxxxxxxxx"

Ответ

json
{
  "points": 1280
}
ПолеТипОписание
pointsintegerТекущее количество доступных баллов

Рекомендации

  • Проверяйте баланс перед пакетной отправкой задач, чтобы не получить 402 insufficient_points на полпути.
  • Можно регулярно запрашивать баланс и напоминать себе купить баллы, когда он опускается ниже порога.
  • Запрос баланса — также самый простой способ проверить, действует ли API-ключ: для недействительного ключа возвращается 401 invalid_api_key.