نمای کلی احراز هویت
API اورکاریل برای موارد استفاده مختلف از دو روش احراز هویت پشتیبانی می‌کند. وارد داشبورد شوید؛ دسترسی به داشبورد از توکن‌های Bearer استفاده می‌کند (که هنگام ورود دریافت می‌شوند). اگر اولین بار است که وارد می‌شوید، پیش از ادامه استفاده از داشبورد یا ساخت کلید API باید یک سازمان بسازید.
روش‌های احراز هویت
۱. توکن Bearer (JWT)
از توکن‌های Bearer برای درخواست‌هایی استفاده کنید که کاربر احراز هویتشان می‌کند؛ مثلاً وقتی کاربر واردشده یک Payment Intent می‌سازد یا منابع سازمانش را مدیریت می‌کند.
مورد استفاده: اپلیکیشن‌های کاربرمحور، دسترسی به داشبورد، عملیات مخصوص کاربر
قالب هدر:
Authorization: Bearer YOUR_JWT_TOKEN
۲. کلید API (Basic Auth)
از کلیدهای API برای درخواست‌های سرور به سرور استفاده کنید؛ مثل سرویس‌های بک‌اند که API را فراخوانی می‌کنند. کلیدهای API درون یک سازمان ساخته می‌شوند.
مورد استفاده: ارتباط سرور به سرور، فرایندهای خودکار، وب‌هوک‌ها
قالب هدر:
Authorization: Basic base64(key:secret)
انتخاب روش احراز هویت
| سناریو | روش پیشنهادی |
|---|---|
| کاربر از اپ شما پرداخت می‌سازد | توکن Bearer (JWT) |
| سرویس بک‌اند پرداخت می‌سازد | کلید API (Basic Auth) |
| دسترسی به داشبورد | توکن Bearer (JWT) |
| پردازش وب‌هوک | کلید API (Basic Auth) |
| فراخوانی API از اپ موبایل | توکن Bearer (JWT) |
قدم‌های بعدی
- کلیدهای API — یاد بگیرید کلید API را چطور بسازید و استفاده کنید
- توکن‌های Bearer — یاد بگیرید چطور با توکن JWT احراز هویت کنید