Баланс и статистика

Текущий баланс, кредитный лимит и статистика использования API

Раздел предоставляет информацию о текущем балансе, кредитном лимите, использовании. Эндпоинты защищены HMAC‑аутентификацией (см. Аутентификация). При недостатке средств сервис может отправить вебхук transcription.low.balance — см. Вебхуки.

Баланс

Для получения текущего баланса пользователя необходимо вызвать GET /v1/billing/balanceКонтракт

TS=$(date +%s)
SIG=$(printf "%s\n%s" "$API_PUBLIC" "$TS" | openssl dgst -sha256 -hmac "$API_SECRET" -hex | sed 's/^.* //')

curl -sS "https://api.transcription.aiesa.ru/api/v1/billing/balance" \
  -H "X-Public-Key: $API_PUBLIC" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"

Статистика использования

Для получения статистики пользования API необходимо вызвать GET /v1/billing/usageКонтракт

Параметры запроса:

ПараметрОписание
periodcurrent_month | last_month | last_3_months | custom (по умолчанию current_month)
date_fromYYYY-MM-DD (при period=custom)
date_toYYYY-MM-DD (при period=custom)
TS=$(date +%s)
SIG=$(printf "%s\n%s" "$API_PUBLIC" "$TS" | openssl dgst -sha256 -hmac "$API_SECRET" -hex | sed 's/^.* //')

curl -sS "https://api.transcription.aiesa.ru/api/v1/billing/usage?period=current_month" \
  -H "X-Public-Key: $API_PUBLIC" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"

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