Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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ètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
Idempotency-Key (header) | string | Non | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
quantity | integer | Oui | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
daily_allowance | integer | Oui | Lookups included per day. `-1` means unlimited. |
used_today | integer | Oui | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Non | — |
top_up_remaining | integer | Non | Purchased lookups still unspent. These do not expire. |
remaining | integer | Oui | — |
is_unlimited | boolean | Non | — |
can_look_up | boolean | Oui | 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 | Non | — |
packs | object[] | Oui | Packs of extra lookups available to buy. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422