Api
کلیدهای API و دامنه‌های دسترسی#
اعتبارنامه‌های API از صفحه تنظیمات تجارت ساخته می‌شوند، نه از یک پورتال جداگانه توسعه‌دهندگان. این کار مالکیت را روشن نگه می‌دارد: یک اعتبارنامه به یک کارمند تعلق دارد، اختییار همان کارمند را به ارث می‌برد، و با رفتن کارمند از خدمت خارج می‌شود.
برای مدیریت آن‌ها تنظیمات > یکپارچه‌سازی‌های API را باز کنید.
چه کسی می‌تواند اعتبارنامه بسازد#
| نقش | می‌تواند دید | می‌تواند بسازد | می‌تواند مدیریت کند |
|---|---|---|---|
| مدیر تجارت | همه اعتبارنامه‌های تجارت | بله | هر اعتبارنامه تجارت |
| مدیر شعبه | فقط اعتبارنامه‌های خودش، محدود به شعبه‌های تحت مدیریت | بله | فقط اعتبارنامه‌های خودش |
| سایر کارمندان | نخیر | نخیر | نخیر |
مدیریت یعنی نام‌گذاری دوباره، چرخش و بازپس‌گیری. ساختن و مدیریت به صلاحیت نوشتن settings نیاز دارند.
ساختن یک اعتبارنامه#
- تنظیمات > یکپارچه‌سازی‌های API را باز کنید.
- ایجاد را برگزینید.
- نامی بگذارید که سیستم مصرف‌کننده را شناسایی کند، برای مثال
ERP syncیاClaude Desktop. - دست‌کم یک صلاحیت را انتخاب کنید.
- تعیین کنید که اعتبارنامه در سطح کل تجارت است یا به شعبه‌ها محدود می‌شود.
- ذخیره کنید، سپس راز را فوراً کپی نمایید.
| فیلد | الزامی | قاعده‌ها |
|---|---|---|
| نام | بله | حداکثر 120 نویسه |
| صلاحیت‌ها | بله | دست‌کم یکی از پنج صلاحیت پشتیبانی‌شده |
| سطح کل تجارت | بله | بولین |
| شناسه‌های شعبه | وقتی سطح کل تجارت نیست | دست‌کم یک، عدد صحیح، متمایز |
راز فقط یک بار نمایش داده می‌شود. تنها یک هش ذخیره می‌شود، بنابراین بعداً قابل بازیابی نیست؛ اگر گم شود، اعتبارنامه را بچرخانید.
صلاحیت‌ها#
| صلاحیت | چه چیزی را باز می‌کند | همچنین نیاز دارد |
|---|---|---|
products:read | کاتالوگ محصولات و جستجو | inventory.products.read |
stock:read | رشته‌های موجودی برای هر شعبه | inventory.branches.read |
purchases:read | فهرست و جزئیات خریدها | purchase.purchases.read |
orders:read | فهرست سفارش‌ها | sale.orders.read |
sales:read | فهرست و جزئیات فروش‌ها | sale.sales.read |
هیچ صلاحیت نوشتن وجود ندارد. اعطای یک صلاحیت هرگز کاری که کارمند می‌تواند در رابط کاربری انجام دهد را گسترش نمی‌دهد، و برداشتن یک اجازه صفحه از نقش، صلاحیت مربوط را بی‌صدا غیرفعال می‌کند.
سطح کل تجارت در برابر دامنه شعبه#
| حالت | رفتار | استفاده معمول |
|---|---|---|
| سطح کل تجارت | همه شعبه‌های فعال را می‌خواند مگر شعبه‌ای نام برده شود | گزارش‌گیری متمرکز، همگام‌سازی ERP |
| شعبه‌های انتخاب‌شده | فقط شعبه‌های اعطاشده را می‌خواند؛ یک شعبه خودکار تعیین می‌شود | ابزار انبار محلی |
یک مدیر شعبه نمی‌تواند اعتبارنامه سطح کل تجارتی بسازد که به شعبه‌های تحت مدیریتش نمی‌رسد. سرور شعبه‌های اعطاشده را با دامنه زندهٔ مدیر بررسی می‌کند و یک درخواست بیش‌ازحد گسترده را رد می‌کند.
چرخش و بازپس‌گیری#
| اقدام | اثر |
|---|---|
| نام‌گذاری دوباره | فقط برچسب را تغییر می‌دهد؛ توکن به کار خود ادامه می‌دهد |
| چرخش | یک راز جدید و یک توکن جدید صادر می‌کند؛ توکن قبلی فوراً از کار می‌افتد |
| بازپس‌گیری | اعتبارنامه را بازپس‌گرفته علامت می‌زند؛ هر درخواست برای همیشه با 401 شکست می‌خورد |
اعتبارنامه‌های بازپس‌گرفته شده را نمی‌توان چرخید، نام‌گذاری دوباره کرد یا دوباره فعال ساخت. به‌جای آن یک اعتبارنامه جدید بسازید.
چرخش پاسخ درست به یک نشت مظنون است، چون راز پیشین را باطل می‌کند بدون آنکه تاریخچه اعتبارنامه از بین برود.
خواندن کارت مصرف#
زبانه یکپارچه‌سازی‌ها طرح، ضریب، سهمیه روزانه و ماهانه، مصرف فعلی و زمان بازنشانی را نشان می‌دهد، به‌اضافه نتیجه‌های اخیر درخواست‌ها برای هر اعتبارنامه.
| فیلد | معنا |
|---|---|
| طرح | طرح مؤثر: free، growth، scale یا enterprise |
| ضریب | بر سهمیه پایه اعمال می‌شود |
| مصرف/حد | درخواست‌های مصرف‌شده در دوره جاری |
| بازنشانی در | وقتی مرز دوره فرا می‌رسد |
| آخرین استفاده | آخرین احراز هویت موفق اعتبارنامه |
سهمیه به ازای هر کاربر است، نه به ازای هر اعتبارنامه: چند اعتبارنامه متعلق به یک کارمند یک سطل مشترک را مصرف می‌کنند.
چک‌لیست امنیتی#
- یک اعتبارنامه برای هر سیستم مصرف‌کننده، با نام روشن.
- کمترین صلاحیت‌ها و کمترین شعبه‌ها.
- راز در یک مدیر راز ذخیره شود، هرگز در کنترل نسخه.
- چرخش پس از تغییرات کارمندی یا یک نشت.
- به‌جای فعال نگه‌داشتن یک اعتبارنامه بی‌استفاده، آن را بازپس بگیرید.
last_used_atرا مرور کنید؛ یک اعتبارنامه بی‌کار معمولاً یک یکپارچه‌سازی رهاشده است.