reseller
PUT /v1/reseller/vendor-policy/clients/{orgId}
Cap or pause one client's paid data checks.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar reseller.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, kuruluş kimliğinizi doğrudan URL içinde orgId olarak alır. Bunu yola ekleyin; bunun yerine geçecek hiçbir başlık veya sorgu parametresi yoktur.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
orgId (path) | Uuid | Evet | The client organization to cap. Must be one of your own clients. |
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
daily_lookup_cap | integer | Hayır | Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants. |
billed_data_enabled | boolean | Hayır | — |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | Evet | `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 | Evet | 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 | Evet | Basis points of the pool at which you are warned. 8000 = 80%. |
client_overrides | ResellerClientVendorRow[] | Evet | Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 422 · 429