認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織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