reseller

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

Cap or pause one client's paid data checks.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن reseller.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه معرف مؤسستك في عنوان 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

التفاصيل

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

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