رفتن به محتوای اصلی
چهارده روز رایگان، فعال‌سازی فوری

راهنمای صفحه

کلیدهای API

به نرم‌افزار خود مجموعه کلیدی بدهید تا منو، سفارش‌ها و مشتریان را بخواند یا موجود بودن آیتم را تغییر دهد؛ فقط با همان دسترسی‌هایی که انتخاب می‌کنید.

به‌روزرسانی: ۱۱ آبان ۱۴۰۵هماهنگ با نسخهٔ 0.232.1 پنلمسیر در پنل: /admin/settings/api-keysپلن: تجاری و زنجیره‌ای

صفحه کجاست

در منوی کناری: اتصال و سامانه ← کلیدهای API.

کادر راهنمای کلید API،‏ ساخت کلید،‏ نام،‏ کلید،‏ دسترسی‌ها،‏ آخرین استفاده،‏ وضعیت،‏ نحوهٔ استفاده، و محدودیت‌ها: ۱۲۰ درخواست در دقیقه برای هر کلید، فهرست‌ها صفحه‌بندی‌شده
  1. ۱کادر «راهنمای کلید API»
  2. ۲«ساخت کلید»
  3. ۳«نام» — نامی که هنگام ساخت داده‌اید
  4. ۴«کلید» — فقط ابتدای کلید، مثل qzk_abcd_…؛ برای شناختن کلید، نه استفاده
  5. ۵«دسترسی‌ها»
  6. ۶«آخرین استفاده» — یا «استفاده نشده»
  7. ۷«وضعیت» — «فعال» یا «ابطال‌شده»؛ در ستون «عملیات»، «ابطال»
  8. ۸«نحوهٔ استفاده» — نشانی‌های قابل استفاده با نمونهٔ درخواست
  9. ۹محدودیت‌ها: ۱۲۰ درخواست در دقیقه برای هر کلید، فهرست‌ها صفحه‌بندی‌شده

ساختن کلید

نام کلید،‏ خواندن منو،‏ خواندن سفارش‌ها،‏ خواندن مشتریان،‏ تغییر موجود بودن آیتم،‏ ساخت کلید، و انصراف
  1. ۱«نام کلید» — برای شناختن کلید، مثلاً «نرم‌افزار انبار»
  2. ۲«خواندن منو» — دسته‌ها، آیتم‌ها، قیمت و موجودی
  3. ۳«خواندن سفارش‌ها» — سفارش‌ها با اقلام و مبالغ
  4. ۴«خواندن مشتریان» — نام، شمارهٔ همراه و ایمیل مشتریان؛ فقط برای نرم‌افزاری که به آن اطمینان دارید
  5. ۵«تغییر موجود بودن آیتم» — ناموجود یا موجود کردن آیتم؛ منوی باز مشتریان همان لحظه به‌روز می‌شود
  6. ۶«ساخت کلید»
  7. ۷«انصراف»

پس از ساخت، پنجرهٔ «کلید «…» ساخته شد» کلید کامل را نشان می‌دهد. با «رونوشت کلید» آن را بردارید و جای امن نگه دارید. پس از «بستن» دیگر نمایش داده نمی‌شود؛ اگر گم شد، کلید تازه بسازید و قبلی را ابطال کنید.

استفاده از کلید

کلید در سرایند Authorization فرستاده می‌شود. خود کلید مجموعه را مشخص می‌کند و همهٔ مبلغ‌ها به ریال است.

نشانیدسترسی لازمکار
GET /tenant-api/v1/menu«خواندن منو»منو
GET /tenant-api/v1/orders«خواندن سفارش‌ها»سفارش‌ها؛ با from و page
GET /tenant-api/v1/customers«خواندن مشتریان»مشتریان؛ با page و pageSize (حداکثر ۱۰۰)
PATCH /tenant-api/v1/menu-items/{id}/availability«تغییر موجود بودن آیتم»بدنه: {"isAvailable": false}

نشانی کامل سرور در کادر «نحوهٔ استفاده» همین صفحه آمده است. کلیدی که دسترسی لازم را نداشته باشد، درخواست را رد شده می‌گیرد.

ابطال

«ابطال» فوری است و برگشت ندارد: نرم‌افزاری که از کلید استفاده می‌کند همان لحظه دسترسی‌اش را از دست می‌دهد. کلید ابطال‌شده با وضعیت «ابطال‌شده» در فهرست می‌ماند تا بدانید چه کلیدی بوده است. کلیدی را که لو رفته، یا نرم‌افزارش دیگر استفاده نمی‌شود، ابطال کنید.

دسترسی و پلن

صفحه در پلن تجاری و زنجیره‌ای است، و در پلن حرفه‌ای با افزودنی «API و Webhook». در پلن دیگر، صفحه کارت «API در پلن تجاری» و دکمهٔ «مشاهدهٔ پلن‌ها» را نشان می‌دهد.

کارنقش‌ها
دیدن، ساختن و ابطال کلیدفقط مالک

مطالب مرتبط

نقش‌ها: مالک

همهٔ مقاله‌های این بخش