API عملیات روی دامنه IR
در این مقاله در مورد وب سرویس عملیات روی دامنه آی آر توضیح دهیم و آن را معرفی کنیم.
در حال حاضر این API دارای قابلیت‌های انجام عملیات مرتبط با دامنه‌های نقطه آی‌آر است
اصول کلی استفاده
درخواستها و پاسخ آنها به وسیلهٔ پیغامهایی انجام میگیرد که به صورت JSON نگاشته میشوند. در این روش کاربران، درخواستهای خود را بصورت یک JSON ایجاد کرده و آن را به آدرس API مورد نظر ارسال میکند و پاسخی با فرمت JSON نیز دریافت میکنند.
جهت تصدیق شناسه شما توسط سامانه بایستی کلید API که مختص هر کاربر است در Header درخواست و با کلیدی با نام X-Api-Key قرار داده شود.
درخواست
متد ارسال اطلاعات به API بسته به نوع عملیات میتوانید یکی از انواع GET، POST، PUT، PATCH و DELETE باشد.
نکته: در درخواست‌هایی که نیاز به ارسال داده دارند، مقدار Header مربوط به Content-Type بایستی بر روی application/json قرار داده شود.
curl -X GET \
https://api.webalfa.net/v2/example-request \
-H ‘x-api-key: demo-key’
پاسخ
در صورت موفقیت آمیز بودن عملیات مقدار پارامتر success به صورت true برگردانده خواهد شد. در غیر این صورت مقدار آن false خواهد بود. در صورتی که نیاز باشد اطلاعاتی از جانب API برگردانده شود این اطلاعات در فیلد result قرار داده خواهد شد.
{
“success”: true,
“result”: {
“version”: “1”
}
}
در صورت موفقیت آمیز نبودن عملیات در پارامتر errors آرایه‌ای که شامل لیستی از خطاهایی است که منجر به لغو عمالیات شده است برگردانده میشود. هر خطا دارای فیلد code جهت مشخص سازی شماره خطا، فیلد message که حاوی متن خطا به زبان انگلیسی و همچنین در صورت نیاز فیلدی با نام extra است که اطلاعاتی تکمیلی در مورد خطای رخ داده شده و دلیل نادرست بودن آن را مشخص میکند.
{
“success”: false,
“errors”: [
{
“code”: 404,
“message”: “Unrecognized request”,
“extra”: {
“incorrect_parameter”: {
“value”: “Incorrect Value”,
“parameter_attribute”: “Attribute value”,
“reason”: “Reason of problem with the value”
}
}
}
]
}
نکته: وجود فیلدهای parameter_attribute و reason در پاسخ خطا ضروری نمیباشد و ممکن است در پاسخ وجود نداشته باشد. در صورت وجود فیلد extra در پاسخ تنها وجود مقدار incorrect_parameter و value در پاسخ قطعی است.
در مقاله بعدی در مورد وب سرویس دامنه ای ار و متد ثبت آن توضیح خواهیم داد.