Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
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> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
Idempotency-Key (header) | string | Không | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
quantity | integer | Có | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
daily_allowance | integer | Có | Lookups included per day. `-1` means unlimited. |
used_today | integer | Có | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Không | — |
top_up_remaining | integer | Không | Purchased lookups still unspent. These do not expire. |
remaining | integer | Có | — |
is_unlimited | boolean | Không | — |
can_look_up | boolean | Có | 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 | Không | — |
packs | object[] | Có | Packs of extra lookups available to buy. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 422