reseller

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

Cap or pause one client's paid data checks.

Svi reseller krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu reseller.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća ID vaše organizacije u samom URL-u, kao orgId. Zamijenite ga u stazi — ne postoji zaglavlje ili parametar upita koji će umjesto toga poslužiti.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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

Parametri

NazivVrstaObaveznoŠto je to
orgId (path)UuidDaThe client organization to cap. Must be one of your own clients.

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
daily_lookup_capintegerNeDaily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants.
billed_data_enabledbooleanNe

Odgovor

NazivVrstaObaveznoŠto je to
seo_data_modestring<own_keys, platform_pool>Da`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_microsintegerDaYour 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_bpsintegerDaBasis points of the pool at which you are warned. 8000 = 80%.
client_overridesResellerClientVendorRow[]DaEvery one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422 · 429