Skip to main content
GET
  • Запрос общего баланса аккаунта пользователя
  • Мониторинг использования на уровне пользователя
  • Поддержка CORS
  • Мониторинг баланса в реальном времени
Получение остатка и использованного баланса аккаунта пользователя. Этот эндпоинт возвращает информацию о балансе на уровне пользователя, независимо от конкретных токенов. Также возвращаются поля кредитов с фиксированной конвертацией 1 USD = 200 credits.

Авторизация

string
обязательно
Все эндпоинты требуют аутентификации Bearer TokenПолучить API ключ:Посетите Страницу управления API ключами для получения API ключаДобавьте в заголовок запроса:

Эндпоинты

Оба эндпоинта имеют одинаковую функциональность.

Ответ

boolean
Успешность запроса
string
Сообщение об ошибке (только при неудаче)
float
Остаток баланса пользователя (возвращается при успехе). Возвращает -1 когда unlimited_quota равно true
float
Использованный баланс пользователя (возвращается при успехе)
float
Оставшиеся credits пользователя (возвращается при успехе). Рассчитывается по курсу 1 USD = 200 credits
float
Использованные credits пользователя (возвращается при успехе)
float
Курс конвертации credits. Сейчас возвращает 200
boolean
Имеет ли пользователь безлимитную квоту. true означает безлимитную, false означает ограниченную

Баланс токена vs Баланс пользователя

Применение

  • Просмотр общего баланса аккаунта пользователя
  • Настройка напоминаний о пополнении и оповещений о балансе
  • Отображение баланса аккаунта в панели управления
Информация о единицах балансаЕдиница измерения баланса зависит от конфигурации системы:
  • USD - Доллары США
  • CNY - Китайские юани
  • Tokens - Количество токенов
Для стабильной интеграции используйте remain_credits и used_credits, если нужны значения в credits. Эти поля всегда используют 1 USD = 200 credits и не зависят от настройки отображения баланса.
Безлимитный пользовательКогда пользователь имеет безлимитную квоту:
  • Поле unlimited_quota возвращает true
  • Поле remain_balance возвращает -1
  • Пользователь не имеет ограничений квоты

Частые ошибки

Примечание по безопасностиВаш API ключ подобен паролю. Храните его в безопасности и не делитесь с другими. Всегда используйте HTTPS в продакшене.