reseller
PUT /v1/reseller/vendor-policy/clients/{orgId}
Cap or pause one client's paid data checks.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントでは、URL内に組織IDを orgId として直接指定します。パスの中にその値を代入してください。この動作を代替するヘッダーやクエリパラメータはありません。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Per-client control inside your own pool. `daily_lookup_cap` can only ever **reduce** what that client's plan already grants — a number above their plan allowance has no effect, because the smaller of the two is what is applied. `billed_data_enabled: false` stops that client drawing on your pool at all; their plan, their sites and their history are untouched and they still see readings already paid for. An org id that is not one of your clients is a 404. Requires `reseller.manage`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
orgId (path) | Uuid | はい | The client organization to cap. Must be one of your own clients. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
daily_lookup_cap | integer | いいえ | Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants. |
billed_data_enabled | boolean | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | はい | `own_keys` runs client SEO and indexing lookups on credentials you connect yourself and is free of charge from us. `platform_pool` runs them on Zinn®'s accounts against your mon… |
monthly_pool_micros | integer | はい | Your monthly allowance of Zinn-funded vendor spend, in USD micros (1,000,000 = $1). Read-only — it is a commercial term of your programme. `null` means **no pool has been set**,… |
alert_at_bps | integer | はい | Basis points of the pool at which you are warned. 8000 = 80%. |
client_overrides | ResellerClientVendorRow[] | はい | Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429