reseller

PATCH `/v1/reseller/vendor-policy`

Switch between your own vendor keys and Zinn®'s metered pool.

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

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение 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, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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`.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422 · 429

PATCH /v1/reseller/vendor-policy