هاست ایران | لوگو
هاست ایران | منو

مستندات فنی

در این قسمت می‌توانید به کمک اتصال استاندارد از امکانات هاست‌ایران به صورت اتصال HTTP استفاده نمایید.

برای شروع نیاز است از قسمت "دسترسی API" از قسمت تنظیمات حساب پروفایل خود کلمه عبور و آدرس اتصال شخصی خود را دریافت کنید.

تنظیمات اتصال

برای اتصال به وب‌سرویس‌های عمومی هاست‌ایران فقط کافی است پس از دریافت توکن و آدرس اختصاصی شما از داخل پروفایل کاربری با در نظر گرفتن Header زیر و مستندات فنی ذیل به وب‌سرویس متصل شوید.

Header

                                {
                                    "token": "{TOKEN}"
                                }

موجودی حساب

با استفاده از درخواست "موجودی حساب" می‌توانید در هر لحظه از موجودی کیف پول خود در هاست ایران مطلع شوید.

https://BASE_URL/v1/credit
GET

Response

 {
"credit": 500000;
"currency": "IRR"
}

صورتحساب ها

به کمک این API شما می‌توانید لیست صورتحساب های پرداخت نشده خود را به همراه جمع صورتحساب و لینک مستقیم پرداخت دریافت کنید.

https://BASE_URL/v1/invoice
GET

Response

[
                               {
                                "id": 505022,
                                "amount": 565656,
                                "link": "https://hostiran.net/pay/505022"
    },
                                {
                                "id": 501383,
                                "amount": 0,
                                "link": "https://hostiran.net/pay/501383"
    },
                                {
                                "id": 501382,
                                "amount": 0,
                                "link": "https://hostiran.net/pay/501382"
    },
                                {
                                "id": 501121,
                                "amount": 0,
                                "link": "https://hostiran.net/pay/501121"
    },
                               {
                                "id": 501119,
                                "amount": 0,
                                "link": "https://hostiran.net/pay/501119"
    }
]

لیست ابرها

با استفاده از این درخواست شما می‌توانید لیست تمامی سرویس های ابری در دسترس خود را در هر لحظه داشته باشید. همچنین می‌توانید از سررسید و هزینه‌ی لحظه‌ای آنها با خبر شوید.

Body

پارامترنوعتوضیح
perPageint تعداد آیتم های بازگشتی در درخواست با محدودیت ۱۰۰ عدد
pageintصفحه‌ی مورد نظر از اطلاعات
https://BASE_URL/v1/cloud?perPage=10&page=1
GET

Response

   "data": [
                                {
                                "id": 61,
                                "name": "database",
                                "next_payment": "2022-06-27 17:00:00",
                                "next_payment_amount": 1088000,
                                "status": "active",
                                "power_status": "on",
                                "actions": [
                                    "poweroff",
                                    "reboot"
                                ]
        },
                                {
                                "id": 60,
                                "name": "web",
                                "next_payment": "2022-06-27 17:00:00",
                                "next_payment_amount": 1328000,
                                "status": "active",
                                "power_status": "off",
                                "actions": [
                                    "start",
                                    "reboot"
                                ]
        }

    ],
    "pagination": {
                                "current_page": 1,
                                "total": 2,
                                "per_page": 10
    }

فعالیت روی ابر

شما می‌توانید با کمک از API قبلی آدرس هر یک از ابرهای خود و همچنین فعالیت های مجاز آن را ببینید و به کمک این درخواست فعالیت های مجاز مانند روشن کردن سرور، خاموش کردن سرور و ... را روی ابر خود پیاده سازی کنید.

https://BASE_URL/v1/cloud/action
Post

Body

پارامترنوعتوضیح
vm_idاجباریintشناسه‌ی ماشین ابری، از API لیست ابرها استخراج شده است.
actionاجباریstringیک فعالیت قابل قبول استخراج شده از API لیست ابرها مانند: reset / poweron/ ....

Response

 "success"