身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
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 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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