گرفتن IP آدرس هاست و ارتباطی – Get IP

• دریافت از طریق API
• سربرگ – Header
• مقادیر ارسالی – Request Data
• پاسخ صحیح – Response True
• پاسخ نادرست – Response False

دریافت از طریق API

عنوان	وضعیت	مقادیر	توضیحات
Method	اجباری	GET	متد ارسال درخواست
Domain	اجباری	نام دامنه ثبت شده در اتوماسیون
Api Url	اجباری	دامنه هسته مرکزی سرویس
Api version	اجباری	به نسخه فعلی سرویس API تلقی میشود که در قسمت پیش نیازهای اتوماسیون به ریز شرح داده شده است.

توضیحات ارسال درخواست

سربرگ – Header

در این روش شما باید درخواست خود را از طریق لینک زیر ارسال فرمائید.

{{Api Url}}/ip

HEADER
GET /api/reservation/{{Api version}}/ip HTTP/1.1
Host: {{Your Host}}
Content-Type: application/json
Domain: {{Your Domain}}

API Url از طریق پنل کاربری قابل مشاهده خواهد بود

مقادیر ارسالی – Request Data

این API نیازی به ارسال داده ندارد.

پاسخ صحیح – Response True

عنوان	نوع	مقادیر	توضیحات
payload	Object
payload.host	IP	آدرس هاست ارسال کننده درخواست	یک آدرس IP برمیگرداند
payload.ip	IP	آدرس کاربر ارسال کننده درخواست	یک آدرس IP برمیگرداند
meta	Object
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

دریافت این پاسخ با Status Code 200 دریافت خواهد شد.

{
    "payload": {
        "host": "192.168.0.5",
        "ip": "192.168.0.170"
    },
    "meta": {
       "timestamp": "Timestamp" // Timestamp
    }
}

 

پاسخ نادرست – Response False

عنوان	نوع	مقادیر	توضیحات
error	Object
error.code	Integer	شماره خطا مربوطه	جهت استعلام خطا میتوانید از طریق این لینک اقدام کنید.
meta	Object
meta.timestamp	Timestamp	زمان تولید پاسخ	این زمان بر اساس timestamp می باشد – در صورت نیاز از این زمان استفاده شود.

{
  "error": {
    "code":"Error Code"
  },
  "meta": {
    "timestamp": "Timestamp" // Timestamp
  }
}

در صورت مشاهده Status Code 404 URL درخواست خود را به اشتباه وارد نموده اید.