reseller

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

Cap or pause one client's paid data checks.

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran reseller.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil ID organisasi anda dalam URL itu sendiri, sebagai orgId. Gantikannya ke dalam laluan — tiada pengepala atau parameter pertanyaan yang akan melakukan sebaliknya.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`orgId (path)`	`Uuid`	Ya	The client organization to cap. Must be one of your own clients.

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`daily_lookup_cap`	`integer`	Tidak	Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants.
`billed_data_enabled`	`boolean`	Tidak	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`seo_data_mode`	`string<own_keys, platform_pool>`	Ya	`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`	Ya	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`	Ya	Basis points of the pool at which you are warned. 8000 = 80%.
`client_overrides`	`ResellerClientVendorRow[]`	Ya	Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`.

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429