Автентифікація
Надішліть ключ 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. |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
quantity | integer | Так | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
daily_allowance | integer | Так | Lookups included per day. `-1` means unlimited. |
used_today | integer | Так | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Ні | — |
top_up_remaining | integer | Ні | Purchased lookups still unspent. These do not expire. |
remaining | integer | Так | — |
is_unlimited | boolean | Ні | — |
can_look_up | boolean | Так | 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_standing | boolean | Ні | — |
packs | object[] | Так | Packs of extra lookups available to buy. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 422