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 زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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