reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.view; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Spend for your whole client base this calendar month, against your pool, broken down by vendor. Always read month_is_floor and ceiling_is_floor before showing a total: some vendors bill prepaid units whose per-unit cost is not priced here, so when a flag is true the money figure is a minimum and month_unpriced_calls counts what it excludes. ceiling_micros is the most your client base could draw in a month if every client used every allowance their plan includes — it does not depend on how busy this month happened to be. Available even when your pool is spent. Requires reseller.view.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
pool_enforced | boolean | Да | Read this first. false means no pool has been set, so nothing is bounded — it does not mean you have a large allowance remaining. |
seo_data_mode | string<own_keys, platform_pool> | Да | — |
pool_micros | integer | Да | — |
month_spent_micros | integer | Да | Priced spend this calendar month. A minimum whenever month_is_floor is true. |
month_remaining_micros | integer | Да | null when no pool is set, or when the month's spend is a floor — an unknown cannot be subtracted from a budget to give a remainder. |
month_is_floor | boolean | Да | true means month_spent_micros understates the truth because a vendor we cannot price per call was used. Show it beside the number. |
month_unpriced_calls | integer | Да | Billed calls this month excluded from the money total. |
should_warn | boolean | Да | You have crossed alert_at_bps of your pool. |
ceiling_micros | integer | Да | The most your client base could draw in a month if every client used every allowance their plan includes. Independent of how busy this month was. |
ceiling_is_floor | boolean | Да | — |
org_count | integer | Да | Organizations counted — you plus your clients. A client of yours who is themselves a reseller has their own pool and is not counted beyond themselves. |
services | ResellerVendorServiceDraw[] | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 429