reseller

PUT `/v1/reseller/vendor-policy/clients/{orgId}`

Cap or pause one client's paid data checks.

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.manage; кључ без ње се одбија уз 403, а не 404.

Где се уноси ID ваше организације

Ова крајња тачка узима ID ваше организације у самом URL-у, као orgId. Замените га у путањи — не постоји заглавље или параметар упита који могу послужити уместо тога.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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…
`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

PUT /v1/reseller/vendor-policy/clients/{orgId}