reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie reseller.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`Uuid`	Nie	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…

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`label`	`string`	Tak	—
`url`	`string`	Tak	—
`icon`	`string`	Nie	—
`position`	`integer`	Nie	—
`new_tab`	`boolean`	Nie	—
`visibility`	`string<both, client, staff>`	Nie	—

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422