Запрос баланса пользователя

Получите оставшийся и использованный баланс текущего пользовательского аккаунта. Этот эндпоинт возвращает информацию о балансе на уровне пользователя, независимо от конкретных токенов, и предназначен для просмотра общего баланса аккаунта.

curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}

Авторизация

Authorization

string

обязательно

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

Authorization: Bearer YOUR_API_KEY

Эндпоинты

GET /v1/user/balance
GET /user/balance

Оба эндпоинта обладают одинаковой функциональностью — вы можете использовать любой из них.

Ответ

success

boolean

Успешно ли выполнен запрос

message

string

Сообщение об ошибке (возвращается только при ошибке)

remain_balance

float

Оставшийся баланс пользователя (возвращается при успешном выполнении). Возвращает -1, когда unlimited_quota равно true

used_balance

float

Использованный баланс пользователя (возвращается при успешном выполнении)

unlimited_quota

boolean

Является ли квота пользователя безлимитной. true — безлимитная, false — ограниченная

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

Сравнение	Баланс токена (`/v1/balance`)	Баланс пользователя (`/v1/user/balance`)
Область	Один токен	Весь пользовательский аккаунт
Источник данных	RemainQuota и UsedQuota токена	quota и used_quota пользователя
Сценарий	Мониторинг использования одного API-ключа	Просмотр общего баланса аккаунта
Ограничение	Лимитами на уровне токена	Лимитами на уровне пользователя

Сценарии использования

Просмотр общего баланса пользовательского аккаунта
Настройка напоминаний о пополнении и оповещений о балансе
Отображение баланса аккаунта в личном кабинете пользователя

Информация о единицах балансаЕдиница значения баланса зависит от конфигурации системы:

USD — доллары США
CNY — китайские юани
Tokens — количество токенов

Пользователь с безлимитной квотойКогда для пользователя установлена безлимитная квота:

поле unlimited_quota возвращает true
поле remain_balance возвращает -1
пользователь не имеет ограничений по квоте и может использовать API без лимитов

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

Сообщение об ошибке	Причина	Решение
No Authorization header	Заголовок Authorization не указан	Добавьте заголовок `Authorization: Bearer sk-xxxxx`
Failed to get user quota	Пользователь не существует	Проверьте, существует ли пользователь, связанный с токеном
Failed to get used quota	Ошибка запроса к базе данных	Обратитесь к администратору для проверки состояния системы

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

Documentation Index

​Авторизация

​Эндпоинты

​Ответ

​Баланс токена и баланс пользователя

​Сценарии использования