reseller
PATCH /v1/reseller/vendor-policy
Switch between your own vendor keys and Zinn®'s metered pool.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението reseller.manage; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X PATCH https://api.zinndigital.com/v1/reseller/vendor-policy \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
`own_keys` runs your clients' SEO and indexing lookups on credentials you connect yourself, and nothing is metered against you here. `platform_pool` runs them on Zinn®'s accounts against the monthly allowance in your programme; when that allowance is spent, further **paid** checks pause for your clients until the month rolls or the pool is raised — nothing is cancelled, no history is lost, and your clients keep seeing the last reading already paid for. Requires `reseller.manage`.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
org_id (query) | Uuid | Не | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | Не | — |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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`. |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429