reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.manage; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X POST https://api.zinndigital.com/v1/reseller/brand/menu \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "label": <string>, "url": <string> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Adds one navigation link. Requires reseller.manage and the white_label entitlement. ⛔ url accepts https://, http:// or a same-origin path beginning /, and nothing else. Your clients click these from inside an authenticated panel on your hostname, so a javascript: link would run in the origin holding their session — the allow-list is what makes that unrepresentable rather than merely filtered. ⛔ Over the limit is a 422 naming the limit, never a silent truncation at read time: a ninth link that simply never appears is a defect nobody can report.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`org_id (query)`	`Uuid`	Ні	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency…

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`label`	`string`	Так	—
`url`	`string`	Так	—
`icon`	`string`	Ні	—
`position`	`integer`	Ні	—
`new_tab`	`boolean`	Ні	—
`visibility`	`string<both, client, staff>`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`label`	`string`	Так	—
`url`	`string`	Так	—
`icon`	`string`	Так	A design-system icon name from `icons`, or `""` for a label-only item.
`position`	`integer`	Так	Sort key. Ties break on the label, so the order is total and stable.
`new_tab`	`boolean`	Так	Renders `target="_blank"`. The panel pairs it with `rel="noopener noreferrer"` unconditionally — that is set on every external item, not only the new-tab ones, because…
`visibility`	`string<both, client, staff>`	Так	Who sees it. Filtered server-side on `GET /v1/branding`: a payload carrying a staff-only link that the app hides has already disclosed it to anybody with a network tab, which…
`external`	`boolean`	Так	Whether the link leaves the panel. Computed here so every renderer agrees.

Помилки, які може повертати ця кінцева точка

401 · 403 · 422

POST /v1/reseller/brand/menu