Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
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> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
Idempotency-Key (header) | string | No | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
quantity | integer | Sì | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
daily_allowance | integer | Sì | Lookups included per day. `-1` means unlimited. |
used_today | integer | Sì | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | No | — |
top_up_remaining | integer | No | Purchased lookups still unspent. These do not expire. |
remaining | integer | Sì | — |
is_unlimited | boolean | No | — |
can_look_up | boolean | Sì | 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 | No | — |
packs | object[] | Sì | Packs of extra lookups available to buy. |
Errori che questo endpoint può restituire
401 · 403 · 422