ساخت سرویس و دریافت کلید دسترسی
برای استفاده از APIهای پلتفرم، شما نیاز به یک «سرویس» دارید. سرویس در واقع ظرفی است که تنظیمات احراز هویت (مانند تعداد ارقام کد، زمان انقضا و...) در آن نگهدا ری میشود. هر سرویس میتواند چندین کلید دسترسی (Token) داشته باشد که برای احراز هویت درخواستهای شما در API استفاده میشود.
۱. ایجاد سرویس جدید
پس از ورود به پنل کاربری، از منوی سمت راست گزینه "سرویسها" و سپس "ایجاد سرویس" را انتخاب کنید. در این مرحله باید تنظیمات پایه احراز هویت را مشخص کنید:
تنظیمات سرویس
-
تعداد ارقام کد (Code Length): مشخص کنید کد احراز هویت چند رقمی باشد (معمولاً ۴ یا ۵ رقم). این تنظیم روی تمامی کانالها (فلشکال، پیامک و...) اعمال میشود.
-
مدت اعتبار (Expiration Time): مشخص کنید که کد ارسال شده تا چند دقیقه معتبر باشد. پس از گذشت این زمان، کد منقضی شده و کاربر باید درخواست مجدد ارسال کند.
ویدئوی آموزشی نحوه ساخت سرویس و کلید دسترسی
۲. ایجاد کلید دسترسی (Access Token)
پس از ساخت سرویس، وارد جزئیات آن شوید. در بخش کلیدهای دسترسی، میتوانید یک توکن جدید بسازید.
این توکن، هویت شما را برای سرورهای ما احراز میکند و باید در بدنه تمام درخواستهای API ارسال شود.
مدیریت کلیدها (Best Practices)
شما میتوانید برای یک سرویس، چندین کلید بسازید. پیشنهاد ما برای تیمهای فنی این است که محیطهای خود را جدا کنند:
- 🔑 کلید اول: برای محیط توسعه (Development/Local)
- 🔑 کلید دوم: برای محیط عملیاتی (Production)
این کار باعث میشود اگر کلید محیط توسعه لو رفت، نیازی به تغییر کلید اصلی سایت (Production) نباشد و فقط کلید اول را حذف کنید.
کلید دسترسی (Token) همانند رمز عبور شماست.
- هرگز توکن را در کدهای فرانتاند (React, Vue, Android App) قرار ندهید.
- توکن را در مخازن عمومی مثل GitHub کامیت نکنید.
- همیشه درخواستهای API را از سمت سرور خود (Backend) ارسال کنید.
قدم بعدی
اکنون که سرویس را ساختید و توکن را دریافت کردید، همه چیز برای ارسال اولین درخواست آماده است. به بخش سرویسها بروید و اولین پیام خود را ارسال کنید: