reseller

POST `/v1/reseller/brand/menu`

Add a link to your clients' panel.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی 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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی 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…

بدنه درخواست

نام	نوع	الزامی	چیست
`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 `Refe…
`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, whic…
`external`	`boolean`	بله	Whether the link leaves the panel. Computed here so every renderer agrees.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 422

POST /v1/reseller/brand/menu