reseller
PUT /v1/reseller/vendor-policy/clients/{orgId}
Cap or pause one client's paid data checks.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění reseller.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Sem patří ID vaší organizace
Tento koncový bod přebírá ID vaší organizace přímo v URL jako orgId. Dosaďte jej do cesty – neexistuje žádná hlavička ani parametr dotazu, které by to udělaly místo toho.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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`.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
orgId (path) | Uuid | Ano | The client organization to cap. Must be one of your own clients. |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
daily_lookup_cap | integer | Ne | Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants. |
billed_data_enabled | boolean | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | Ano | `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 | Ano | 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 | Ano | Basis points of the pool at which you are warned. 8000 = 80%. |
client_overrides | ResellerClientVendorRow[] | Ano | Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429