Rest API Key چیست؟
API مخفف Application programming interface می باشد که به معنای رابط برنامه نویسی کاربردی یا رابط برنامه نویسی نرم افزاری می باشد.
در برنامه نویسی وب API برای تعریف زیر روال ها، پروتکل ها و ابزارها برای ساخت نرم افزار و اپلیکیشن ها تنظیم می شود.
یک API می تواند توسعه ی یک برنامه را برای محیا کردن ساختار آن در حد ممکن ساده کند.
API می تواند برای سیستم براساس وب، سیستم عامل، پایگاه داده، سخت افزار کامپیوتری و نرم افزار کامپیوتر مورد استفاده قرار گیرد.
کاربرد ارسال پیامک وبسرویس با api key
در واقع REST یک روش ساده و انعطاف پذیری برای استفاده از API است و البته محبوب ترین و پر کاربرد ترین که میتوان توسط این ساختار از هر کلاینت و پلتفرمی درخواست ساده HTTP(S) را ارسال و پاسخ آن را دریافت نمود و خروجی را در غالب فرمت های XML و JSON برگشت میدهد.
اگر با JSON آشنائی ندارید میتوانید با مراجعه به سایت json.org هم از ساختار فرمت آن مطلع شوید و هم درایور مربوط به زبان برنامه نویسی مورد نظر خود را دریافت نمائید.
نحوه ساخت Rest API KEY
وارد پنل پیامک خود در قسمت خدمات وب سرویس > لیست کلید های دسترسی، یک ApiKey برای خود ثبت نمائید.
برای ایجاد آن باید دکمه جدید را بزنیم و موضوع خودمان را وارد نماییم و سپس دکمه ثبت را می زنیم سپس apikey تولید می شود.
نحوه استفاده از api key برای ارسال پیامک پترن با url
این مقدار پیش فرض و ثابت است و تغیری نمی کند.
ابتدای لینک : http://ippanel.com:8080/?apikey= را قرار دهید و سپس مقدار کلید تولید شده را باید قرار دهید
pid: کد پترن
fnum: شماره ارسال کننده (پیشنهاد ما استفاده از خط خدماتی است که پیامک وب سرویس به شماره های مسدود ارسال شود)
tnum: شماره مقصد
p1: اولین متغیر پترن
p2: دومین متغیر پترن
v1 – مقدار متغیر اول
v2 – مقدار متغیر دوم
دقت داشته باشید که اگر متغیر های پترن بیشتر باشد، باید بترتیب متغیر ذکر شود و سپس مقداری کنید. بعد از مشخص شدن هر کدام از این موارد باید به ترتیب در کنار هم قرار بگیرند فقط لازم بذکر است که بین هر کدام از این موارد باید یک علامت & استفاده کنیم.
امیدوارم این مقاله در مورد راهنمای استفاده از aki key در سامانه پیامک برای شما مفید بوده باشد، در صورتی که سوالی در مورد اتصال سامانه پیامک به اپلیکیشن خود از طریق Rest API Key دارید می توانید در بخش دیدگاه های مقاله ارسال پیامک از طریق Rest API Key مطرح نمایید.
2 پاسخ
سلام , ممنون از مقاله خوب تون.
برنامه ای با زبان ویژوال بیسیک کلاسیک vb6 نوشته شده و ارسال پیامک از طریق Url انجام میشه . اما میخوام بتونم از طریق متد Rest هم اعتبار پنل رو در برنامه دریافت کنم و هم پیامک رو از پنل . از پروتکل WinHttp.WinHttpRequest استفاده کردم اما نمیتونم با وب سرویس Rest ارتباط بگیرم . آیا نمونه کدی برای vb6 در این مورد دارید یا میتونید راهنمایی بفرمایید . با تشکر
با سلام.
تمامی نمونه کدهای موجود در بخش وب سرویس موجود میباشند.