Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
Idempotency-Key (header) | string | Nem | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
quantity | integer | Igen | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
daily_allowance | integer | Igen | Lookups included per day. `-1` means unlimited. |
used_today | integer | Igen | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Nem | — |
top_up_remaining | integer | Nem | Purchased lookups still unspent. These do not expire. |
remaining | integer | Igen | — |
is_unlimited | boolean | Nem | — |
can_look_up | boolean | Igen | 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 | Nem | — |
packs | object[] | Igen | Packs of extra lookups available to buy. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422