reseller

POST /v1/reseller/brand/menu

Add a link to your clients' panel.

Svi reseller krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu reseller.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

NazivVrstaObaveznoŠto je to
org_id (query)UuidNeThe 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…

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
labelstringDa
urlstringDa
iconstringNe
positionintegerNe
new_tabbooleanNe
visibilitystring<both, client, staff>Ne

Odgovor

NazivVrstaObaveznoŠto je to
idstringDa
labelstringDa
urlstringDa
iconstringDaA design-system icon name from icons, or "" for a label-only item.
positionintegerDaSort key. Ties break on the label, so the order is total and stable.
new_tabbooleanDaRenders 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>DaWho 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…
externalbooleanDaWhether the link leaves the panel. Computed here so every renderer agrees.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 422