Упълномощаване
Изпратете 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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. |
Грешки, които този крайpoint може да върне
401 · 403 · 422