Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
Idempotency-Key (header) | string | Ne | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
quantity | integer | Ano | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
daily_allowance | integer | Ano | Lookups included per day. `-1` means unlimited. |
used_today | integer | Ano | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Ne | — |
top_up_remaining | integer | Ne | Purchased lookups still unspent. These do not expire. |
remaining | integer | Ano | — |
is_unlimited | boolean | Ne | — |
can_look_up | boolean | Ano | 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 | Ne | — |
packs | object[] | Ano | Packs of extra lookups available to buy. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422