reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د 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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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