reseller
PUT /v1/reseller/vendor-policy/clients/{orgId}
Cap or pause one client's paid data checks.
Doğrulama
API açarını bearer token kimi göndərin. Açar reseller.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə təşkilatınızın identifikatorunu birbaşa URL-də orgId kimi qəbul edir. Onu yola daxil edin — bunun əvəzinə işləyəcək heç bir başlıq və ya sorğu parametri yoxdur.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
orgId (path) | Uuid | Bəli | The client organization to cap. Must be one of your own clients. |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
daily_lookup_cap | integer | Xeyr | Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants. |
billed_data_enabled | boolean | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | Bəli | `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 | Bəli | 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 | Bəli | Basis points of the pool at which you are warned. 8000 = 80%. |
client_overrides | ResellerClientVendorRow[] | Bəli | Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`. |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422 · 429