Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
Idempotency-Key (header) | string | Nein | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
quantity | integer | Ja | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
daily_allowance | integer | Ja | Lookups included per day. `-1` means unlimited. |
used_today | integer | Ja | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Nein | — |
top_up_remaining | integer | Nein | Purchased lookups still unspent. These do not expire. |
remaining | integer | Ja | — |
is_unlimited | boolean | Nein | — |
can_look_up | boolean | Ja | 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 | Nein | — |
packs | object[] | Ja | Packs of extra lookups available to buy. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 422