احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
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.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
Idempotency-Key (header) | string | خیر | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
quantity | integer | بله | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
daily_allowance | integer | بله | Lookups included per day. `-1` means unlimited. |
used_today | integer | بله | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | خیر | — |
top_up_remaining | integer | خیر | Purchased lookups still unspent. These do not expire. |
remaining | integer | بله | — |
is_unlimited | boolean | خیر | — |
can_look_up | boolean | بله | 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 | خیر | — |
packs | object[] | بله | Packs of extra lookups available to buy. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 422