احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/orders \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The organization's orders, newest reachable by paging. Requires `billing.view`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
cursor (query) | string | خیر | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | خیر | Maximum items to return (page size). |
status (query) | OrderStatus | خیر | Filter by order status. |
org_id (query) | Uuid | خیر | Restrict to one organization in scope. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
data | Order[] | بله | — |
page | PageMeta | بله | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 422 · 429