reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте reseller.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте сұрау параметрі ретінде 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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`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…

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`label`	`string`	Иә	—
`url`	`string`	Иә	—
`icon`	`string`	Жоқ	—
`position`	`integer`	Жоқ	—
`new_tab`	`boolean`	Жоқ	—
`visibility`	`string<both, client, staff>`	Жоқ	—

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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