نکات استفاده از API الو پیک
در مطلب قبل در مورد معرفی وب سرویس الو پیک و API الو پیک متد دریافت آدرس صحبت کردیم در این مطلب در مورد نکات استفاده وب سرویس الو پیک صحبت خواهیم کرد.
- وب سرویس الو پیک به صورت RESTful است
- این وب سرویس از افعال استاندارد HTTP مانند GET ، POST ، PUT و PATCH استفاده می کند
- برای توصیف خطاها از پاسخهای خطای HTTP استاندارد استفاده می کند
- احراز هویت و مجوزها براساس استاندارد JWT (JSON Web Token) انجام شده است
- همه ارتباطات با سرورهای ما از طریق SSL آغاز می شوند (https: //)
- تمام پاسخ های ما در قالب JSON است
- API با استفاده از دامنه https://sandbox-api.alopeyk.com قابل دسترسی است
- فراموش نکنید که “X-Requested-With: XMLHttpRequest” را در عنوان درخواست تنظیم کنید.
محدودیت ها
API ما بر اساس IP محدود است. محدود کردن API در وهله اول بر اساس هر کاربر ساخته می شود ، اما کلیه درخواستهایی که قبل از تأیید اعتبار انجام شده اند محدود به منبع IP آن درخواست هستند.
عوامل اصلی محدودیت ما درخواست در هر دقیقه و درخواست روزانه است. اگر هر یک از این دو محدودیت را پشت سر بگذارید ، دسترسی شما برای یک زمانی مشخص محدود یا مسدود خواهد شد ، بنابراین باید منتظر بمانید تا این مدت تمام شود.
Response Header
{
…
“X-MinuteRateLimit-Identifier”: “[IP]:[YYYY]-[MM]-[DD]-[hh]-[mm]”,
“X-MinuteRateLimit-Limit”: “100”,
“X-MinuteRateLimit-Remaining”: “XX”
…
}
محدودیت روزانه
در حال حاضر شما می توانید تا 43200 درخواست هر روز ارسال کنید. شما قادر خواهید بود سهمیه فعلی را در هر هدر پاسخ بررسی کنید.
Response Header
{
…
“X-DailyRateLimit-Identifier”: “[IP]:[YYYY]-[MM]-[DD]-[hh]-[mm]”,
“X-DailyRateLimit-Limit”: “43200”,
“X-DailyRateLimit-Remaining”: “XX”
…
}
اهتبار سنجی
تمام متدهای Alopeyk API از پروتکل تأیید اعتبار JWT پشتیبانی می کنند.
برای شروع ارسال درخواست های معتبر HTTP ، باید از نشانه مجوز JWT خود که برای شما ارسال شده است استفاده کنید.
از آنجا که یک نشانه معتبر دارید ، باید آن را به عنوان یک هدر HTTP به هر درخواست HTTP که به API Alopeyk ارسال می کنید اضافه کنید.
GET https://sandbox-api.alopeyk.com/some_endpoint HTTP/1.1
Authorization: Bearer <JWT_TOKEN>
Host: sandbox-api.alopeyk.com
نشانه JWT شما مدت زمان طولانی دارد ، اگرچه این مدت ممکن است در آینده کاهش یابد. توجه داشته باشید که رمز شما تا زمانی که درخواست جدید نکنید درخواست شما تمام نشده است.
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9……….
برای تأیید اعتبار ، از این کد استفاده کنید:
curl “https://sandbox-api.alopeyk.com/api/v2/” \
-X GET \
-H “Authorization: Bearer ${$token}” \
-H “X-Requested-With: XMLHttpRequest”
مطمئن شوید که $ token را با JWT Token خود جایگزین کردید