reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास reseller.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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 agency…

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`label`	`string`	हाँ	—
`url`	`string`	हाँ	—
`icon`	`string`	नहीं	—
`position`	`integer`	नहीं	—
`new_tab`	`boolean`	नहीं	—
`visibility`	`string<both, client, staff>`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`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