reseller

POST /v1/reseller/brand/menu

Add a link to your clients' panel.

Све reseller крајње тачке

Сва документација за програмере →

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

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.manage; кључ без ње се одбија уз 403, а не 404.

Где се уноси ID ваше организације

Ова крајња тачка прихвата 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 конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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…

Тело захтева

НазивТипОбавезноШта је ово
labelstringДа—
urlstringДа—
iconstringНе—
positionintegerНе—
new_tabbooleanНе—
visibilitystring<both, client, staff>Не—

Одговор

НазивТипОбавезноШта је ово
idstringДа—
labelstringДа—
urlstringДа—
iconstringДаA design-system icon name from icons, or "" for a label-only item.
positionintegerДаSort key. Ties break on the label, so the order is total and stable.
new_tabbooleanДа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…
visibilitystring<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…
externalbooleanДаWhether the link leaves the panel. Computed here so every renderer agrees.

Грешке које ова крајња тачка може вратити

401 · 403 · 422