احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/content/link-sets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Gated on `links.edit`. Shares are optional: leave every one blank and the links rotate evenly; set some and the rest share what is left. A set whose shares cannot be resolved is refused with a sentence naming the total, not a code.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | string | خیر | — |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
name | string | خیر | — |
notes | string | خیر | — |
is_archived | boolean | خیر | — |
entries | LinkSetEntry[] | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | string | بله | — |
name | string | بله | — |
notes | string | بله | — |
is_archived | boolean | بله | An archived set is hidden from the picker and takes no new recipes; the recipes already using it keep working. Archiving is offered where deleting is refused. |
entries | LinkSetEntry[] | بله | — |
created_at | string | بله | — |
updated_at | string | بله | — |
recipe_count | integer | بله | How many recipes point at this set — so a delete button can say so first. |
distribution | object[] | بله | The resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses. |
distribution_error | string | بله | Why there is no distribution, or empty. Separate from `distribution` because an empty list also means "this set has no links", and one value for two facts is not an answer. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 422