reseller

POST /v1/reseller/brand/menu

Add a link to your clients' panel.

සියලුම reseller අන්ත ලක්ෂ්‍ය

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි reseller.manage අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්‍රතික්ෂේප කෙරේ.

ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය

මෙම අවසාන ලක්ෂ්‍යය (endpoint) විමසුම් පරාමිතියක් ලෙස org_id ලබා ගනී. එය ඉවත් කළ විට ඇමතීම ඔබේ මුළු කුලී උප වෘක්ෂය (tenancy subtree) ආවරණය කරයි; ඇමතීම එක් සංවිධානයකට පමණක් සීමා කිරීමට එය යවන්න.

ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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.

පරාමිතීන්

නමවර්ගයඅත්‍යවශ්‍යයිඑය කුමක්ද
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 agen…

ඉල්ලුම් පත්‍ර ශරීරය

නමවර්ගයඅත්‍යවශ්‍යයිඑය කුමක්ද
labelstringඔව්
urlstringඔව්
iconstringනැත
positionintegerනැත
new_tabbooleanනැත
visibilitystring<both, client, staff>නැත

පsspil

නමවර්ගයඅත්‍යවශ්‍යයිඑය කුමක්ද
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 `Refe…
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, whic…
externalbooleanඔව්Whether the link leaves the panel. Computed here so every renderer agrees.

මෙම අවසාන ලක්ෂ්‍යය ආපසු ලබා දිය හැකි දෝෂ

401 · 403 · 422