متد HTTP/ GET چیست؟
یکی از ساده ترین راه های ارتباطی با سرور استفاده از پروتکل TCP با هدر HTTP می باشد، ساده ترین روش ارسال داده در قالب HTTP استفاده از متد GET می باشد.
درخواست های از نوع متد get بدنه یا body ندارند چرا که عمدتا برای درخواست اطلاعات استفاده می شود. در این روش آدرس، پورت و دیتای مورد نظر در قالب یک رشته حرفی با هدر های مناسب به سمت سرور ارسال می شود و جواب مورد نظر دریافت خواهد شد. قالب یا فرمت این روش به شکل زیر است :
|
1 |
http://cloud.iotplus.ir:portnumber/api?value1=111&value2=55 |
پارامتر ها با ? شروع میشوند و هر property میتواند value داشت باشد یا نداشته باشد و مقادیر با & از هم جدا می شوند.
ساختار API پلتفرم در IOT+ :
در صورتی که شما قابلیت استفاده از کتابخانه های کدنویسی ارتباط با سرور را ندارید و نیاز دارید تا اطلاعات شما با ساده ترین روش به سمت سرور ارسال شود استفاده از HTTP API راه حل مناسب و آسانی می باشد، تا کمترین حجم کد نویسی ارسال دیتا مورد نظر را به دستگاه انجام دهید.
از مزایای این APi ساده بودن روش و کم بودن حجم کدنویسی و معایب آن فقط ارسال اطلاعات توسط کلاینت و زیاد بودن تعداد بایت کانکشن به سمت سرور در هر بار ارسال می باشد.
برای استفاده ازآن شما نیاز به TOKENKEY ایجاد در اکانت کاربری دارید، در وب پنل ورود کنید، وارد قسمت “اطلاعات ارتباطی” شوید، در این قسمت نمونه کد و کلید اتصال نمایش داده می شود.
با توجه به اینکه در پنل یک دستگاه تعریف و یک کانال به آن اختصاص داده می شود، جهت ارسال اطلاعات به کانال دستگاه مورد نظر فقط کافیست شما نام دستگاه را در دستور ارسالی قرار دهید.
کد دستوری به فرمت زیر قابل قبول می باشد :
|
1 2 3 4 |
// key=کلید اتصال // dev= نام دستگاه // msg=پیام ارسالی http://cloud.iotplus.ir:3030/api?key=HTTP-KEY&dev=DEVICE-NAME&msg=YOUR-MESSAGE |
در این قسمت موارد کلید اتصال و نام دستگاه کاملا مشخص می باشد، اما جهت ارسال اطلاعات برای ویجت مورد نظر بایستی نام متغییر آنرا در قالب Json در پیام ارسالی قرار دهید. ( آشنایی با Json)
جهت آسانتر این مورد که کاربر براحتی متغییرهای هر ویجت را دستگاه مورد نظر استفاده کند به شکل زیر عمل کنید :
- در منوی وب پنل وارد دستگاه شوید.
- وارد دستگاه مورد نظر شوید.
- در منوی بالای دستگاه سمت چپ روی تنظمیات کلیک کنید سپس روی گزینه ” ایجاد API HTTP/GET” کلیک کنید، در پنجره باز شده شکل کل دستور مورد نیاز را مشاهده می کنید، دستور APi را کپی کنید و جهت استفاده کافی است مقادیر پارامترهای ایجاده شده را اپدیت نمایید.
به عنوان مثال دستگاهی داریم که مقدار دما را باید به سمت سرور فقط ارسال کند و یک ماژول گیج ساعتی بایستی نمایش دهد، از قبل یک کانال ایجاد شده با نام Ch01 داریم ، یک دستگاه را با نام dev1 ایجاد می کنیم.
وارد قسمت اضافه نمودن ویجت شده و یک ویجت ساعتی با پارامتر val11 اضافه می کنیم. دستور اپدیت HTTP/GET به صورت زیر می باشد :
|
1 |
http://cloud.iotplus.ir:3030/api?key=xxxxxxxxxxxxx&dev=dev1&msg={”val11”:”89”} |
خروجی ها ( پاسخ های ) HTTP/GET APi :
|
1 2 3 |
// {"result":"OK","msg":"SENDSUCCESSFULL"} = > اطلاعات بصورت صحیح ارسال شده است //{"result":"ERROR","msg":"APIKEYERROR"} => خطا در شناسایی کد ورود //{"result":"ERROR","msg":"NOTVALIDDEVICE"} => خطا ، دستگاه وارد شده موجود نمی باشد |
