reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění reseller.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`org_id (query)`	`Uuid`	Ne	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…

Tělo požadavku

Název	Typ	Požadováno	Co to je
`label`	`string`	Ano	—
`url`	`string`	Ano	—
`icon`	`string`	Ne	—
`position`	`integer`	Ne	—
`new_tab`	`boolean`	Ne	—
`visibility`	`string<both, client, staff>`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`string`	Ano	—
`label`	`string`	Ano	—
`url`	`string`	Ano	—
`icon`	`string`	Ano	A design-system icon name from `icons`, or `""` for a label-only item.
`position`	`integer`	Ano	Sort key. Ties break on the label, so the order is total and stable.
`new_tab`	`boolean`	Ano	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>`	Ano	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`	Ano	Whether the link leaves the panel. Computed here so every renderer agrees.

Chyby, které může tento koncový bod vrátit

401 · 403 · 422