وب سرویس
ارسال و دریافت پیامک
احراز هویت با Api Key
وب سرویس RESTful مربوطه امکان احراز هویت با کلید API را نیز فراهم می نماید. روش مربوطه ساده و سریع می باشد و نیازی به دریافت توکن ندارد.
-
1- تعریف کلید Api
-
ابتدا از طریق منوی امکانات پیشرفته، خدمات وب، مدیریت کلیدهای Api، گزینه ی تعریف کلید Api، کلید مورد نظر خود را
ایجاد نمایید.
-
تنظیمات امنیتی :
-
تعیین سطح دسترسی Api key به متدهای وب سرویس :
شما می توانید تعیین نمایید که Api Key مورد نظر به چه متدهایی از وب سرویس دسترسی داشته باشد. به این ترتیب تنها متدهای مربوطه می توانند توسط Api Key مورد نظر فراخوانی گردند و در صورت فراخوانی متدی که در سطح دسترسی Api Key تعریف نشده باشد کد خطای 403 باز گردانده می شود.
-
تعیین آدرس های IP معتبر :
در صورت تمایل در زمان تعریف کلید Api می توانید نسبت به تعریف آدرس های IP معتبر جهت فراخوانی وب سرویس اقدام نمایید. در صورت تعیین آدرس های IP معتبر، درخواست هایی با مبدا غير از آدرس های IP تعریف شده با کد خطای 403 مواجه خواهند شد و سرویس از پاسخ گویی به این درخواست ها خودداری می نماید.
-
تعیین تاریخ انقضا کلید :
شما می توانید کلید API را بدون تاریخ انقضا ایجاد نمایید یا برای کلید یک تاریخ انقضای دلخواه تعیین نمایید به این ترتیب پس از فرا رسیدن تاریخ انقضا، کلید به صورت خودکار منقضی شده و دیگر قابل استفاده نخواهد بود.
-
2- ارسال کلید در هدر درخواست ها :
-
برای هر درخواست به وب سرویس، کلید ایجاد شده می بایست در هدر HTTP با نام
X-Api-Key
قرار گیرد و به صورت زیر ارسال گردد:
X-Api-Key: <YourApiKey>
