Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X POST https://api.zinndigital.com/v1/seo/quota/top-up \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "quantity": <integer> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Buys a pack of additional lookups, paid from the account credit balance. Purchased lookups do not expire and are spent only once the daily plan allowance is used up. Idempotent on the Idempotency-Key header: repeating a request with the same key returns the same purchase rather than buying a second pack. 422 when the pack size is not sold or the credit balance does not cover it — in which case nothing is charged at all.

Параметри

НазваТипОбов'язковеЩо це таке
Idempotency-Key (header)stringНіCaller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack.

Тіло запиту

НазваТипОбов'язковеЩо це таке
quantityintegerТакThe pack size to buy. Must be one offered by GET /v1/seo/quota.

Відповідь

НазваТипОбов'язковеЩо це таке
daily_allowanceintegerТакLookups included per day. -1 means unlimited.
used_todayintegerТакPlan-funded lookups run since midnight UTC.
plan_remainingintegerНі
top_up_remainingintegerНіPurchased lookups still unspent. These do not expire.
remainingintegerТак
is_unlimitedbooleanНі
can_look_upbooleanТакWhether a lookup would be permitted right now. Not the same as remaining > 0: a suspended or unpaid account may have lookups left and still be refused.
in_good_standingbooleanНі
packsobject[]ТакPacks of extra lookups available to buy.

Помилки, які може повертати ця кінцева точка

401 · 403 · 422