مقدمه
برای استفاده از API های گیفتی کارت، نیاز به احراز هویت و اعتبارسنجی دارید. این مستندات به شما کمک میکند تا با نحوه احراز هویت و استفاده از کلیدهای API آشنا شوید.
فرآیند احراز هویت
فرآیند احراز هویت در دو مرحله انجام میشود:
- دریافت توکن JWT با استفاده از کلیدهای API
- استفاده از توکن JWT برای دسترسی به سایر APIها
برای کسب اطلاعات بیشتر در خصوص JSON Web Tokens (JWT) این مطلب در ویکی پدیا میتواند مفید باشد.
مرحله 1: دریافت توکن JWT
برای دریافت توکن JWT، باید درخواست POST به آدرس زیر ارسال کنید:
POST
/auth/get-token
پارامترهای درخواست
consumer_key: کلید مصرفکننده APIconsumer_secret: رمز مصرفکننده API
مثال درخواست
curl -X POST \
'https://api.gifticard.com/auth/get-token?consumer_key=YOUR_CONSUMER_KEY&consumer_secret=YOUR_CONSUMER_SECRET' \
-H 'Content-Type: application/json'
پاسخ موفق
{
"message": "Token generated successfully"
}
مستندات کامل این بخش را در این قسمت ببینید: دریافت توکن اعتبارسنجی
توکن JWT در هدر Authorization پاسخ برگردانده میشود.
مرحله 2: اعتبارسنجی توکن JWT
دسترسی به سایر روت ها با توکن دریافتی امکان پذیر است. این توکن 1 ساعت اعتبار دارد و پس از آن میبایست توکن جدید دریافت شود.
جهت جلوگیری از بروز خطا میبایست پیش از استفاده از توکن آن را نزد خودتان اعتبارسنجی کنید تا از معتبر بودن آن مطمئن باشید.
استفاده از ابزار آنلاین jwt.io میتواند برای محیط توسعه در این زمینه مفید باشد.
مرحله 3: استفاده از توکن JWT
پس از دریافت توکن JWT، میتوانید از آن برای دسترسی به سایر APIها استفاده کنید. توکن را در هدر Authorization به صورت زیر ارسال کنید:
Authorization: Bearer YOUR_JWT_TOKENدریافت کلیدهای API
برای دریافت کلیدهای API (Consumer Key و Consumer Secret) باید به پنل کاربری خود مراجعه کنید:
- وارد پنل کاربری خود شوید
- به بخش تنظیمات API مراجعه کنید
- پس از فعالسازی پلن مربوطه کلیدهای API خود را دریافت کنید
خطاهای احراز هویت
در صورت بروز خطا در احراز هویت، ممکن است با یکی از پیامهای زیر مواجه شوید:
401 Unauthorized: توکن نامعتبر یا منقضی شده است403 Forbidden: دسترسی به این منبع برای شما محدود شده است429 Too Many Requests: تعداد درخواستها از حد مجاز بیشتر شده است
امنیت
برای حفظ امنیت کلیدهای API خود، موارد زیر را رعایت کنید:
- هرگز کلیدهای API را در کد سمت کلاینت قرار ندهید
- از HTTPS برای تمام درخواستها استفاده کنید
- کلیدهای API را به صورت دورهای تغییر دهید
- دسترسیهای API را به حداقل مورد نیاز محدود کنید
