Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
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> }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
Idempotency-Key (header) | string | Tidak | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
quantity | integer | Ya | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
daily_allowance | integer | Ya | Lookups included per day. `-1` means unlimited. |
used_today | integer | Ya | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Tidak | — |
top_up_remaining | integer | Tidak | Purchased lookups still unspent. These do not expire. |
remaining | integer | Ya | — |
is_unlimited | boolean | Tidak | — |
can_look_up | boolean | Ya | 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 | Tidak | — |
packs | object[] | Ya | Packs of extra lookups available to buy. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 422