دسترسی API

**پنل کلاب → ابزارها و توسعه → مستندات API**

پیش‌نیاز

• آپشن دسترسی API در اشتراک کلاب فعال باشد.
• حساب مالک کلاب یا پرسنل با دسترسی مشاهده تنظیمات.

آشنایی

صفحه سه بخش دارد: فهرست مطالب (عناوین فصل‌ها)، متن راهنما (وسط)، جستجو. محتوا همان مستند رسمی اتصال باشگاه به بیرون است — به زبان ساده توضیح می‌دهد «چه کارهایی از راه دور ممکن است» (مشتریان، سفارش، کیف پول و…).

گام‌به‌گام — مطالعه

1. وارد پنل کلاب شوید.
2. ابزارها و توسعه → مستندات API.
3. از فهرست روی موضوع کلیک کنید (مثلاً «مشتریان»، «ورود»).
4. در جستجو کلمه مثل «کیف» یا «سفارش» را تایپ کنید.
5. روی کپی کنار نمونه‌ها بزنید تا برای برنامه‌نویس بفرستید (آدرس سایت و رمزها را خودتان جایگزین کنید).

نکات

• این صفحه برای مطالعه است؛ تست زنده معمولاً در ابزار Swagger (لینک در همان صفحه یا از ادمین) انجام می‌شود.
• توکن API باشگاه را فقط به فنی مورد اعتماد بدهید — مثل رمز مدیریت.

پیش‌نیاز

• نام کاربری و رمز مالک کلاب، یا توکن API که ادمین پلتفرم در ویزارد کلاب ساخته.

آشنایی

دو راه رایج: ورود با نام کاربری (مثل ورود خودتان به پنل — مناسب اسکریپت داخلی) و توکن اختصاصی باشگاه (مناسب سرور شما بدون login هر بار). بدون یکی از این‌ها سیستم درخواست بیرونی را قبول نمی‌کند.

گام‌به‌گام — دریافت توکن API

1. از ادمین پلتفرم بخواهید در جزئیات کلاب (مرحله API ویزارد) توکن API تولید کند.
2. توکن را امن کپی کنید (یک‌بار نمایش — گم شد دوباره تولید کنید).
3. به برنامه‌نویس بدهید — نه در ایمیل عمومی و نه داخل اپ موبایل کاربر.

گام‌به‌گام — تست ساده

1. برنامه‌نویس با توکن یک درخواست اطلاعات باشگاه یا داشبورد می‌زند.
2. اگر خطای ورود آمد: توکن یا نام کاربری/رمز را چک کنید.
3. اگر خطای دسترسی آمد: آن بخش (مثلاً صندوق) آپشن فعال ندارد.

نکات

• توکن را در GitHub یا کد عمومی commit نکنید.
• برای ساخت کاربر پرسنل پنل فقط ورود با نام کاربری مجاز است — نه توکن.

آشنایی

بسته به آپشن‌های فعال باشگاه، معمولاً این حوزه‌ها پوشش داده می‌شود:

لیست دقیق در فهرست مستندات و Swagger به‌روز است.

نکات

• اگر منویی در پنل وب نیست، API همان بخش هم غیرفعال است.
• کاربر پرسنل محدود به مجوز نقش خودش است؛ مالک دسترسی کامل‌تر دارد.

سناریو ۱ — همگام مشتری با CRM

1. CRM سازنده از مستندات بخش مشتریان را می‌خواند.
2. هر شب لیست جدید/تغییرکرده را می‌گیرد.
3. شما در پنل کلاب نتیجه را با چند مشتری تست مقایسه می‌کنید.

سناریو ۲ — گزارش سفارش روزانه

1. پرسنل مالی با حساب محدود فقط مشاهده سفارش.
2. گزارش به ایمیل مدیر — بدون دسترسی به کیف پول.

سناریو ۳ — وب‌هوک (اعلان به سرور شما)

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

نکات

1. توکن API = کلید باشگاه — فقط روی سرور امن.
2. برای پرسنل API، کمترین دسترسی (فقط همان ماژول لازم).
3. توکن لو رفت → از ادمین توکن جدید بگیرید و قدیمی را باطل کنید.
4. اتصال از مرورگر کاربر به API کلاب توصیه نمی‌شود (امنیت).

• API = اتصال ماشین به ماشین (سرور شما).
• دسترسی کاربران = کارمندانی که خود پنل وب را باز می‌کنند.

هر دو جدا تنظیم می‌شوند؛ API جایگزین ساخت پرسنل برای کار روزمره نیست.