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

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

برای اتصال به وب‌سرویس‌های عمومی هاست‌ایران،
1) ابتدا از پروفایل کاربری خود BASE_URL و TOKEN را بردارید.
2) سپس با در نظر گرفتن پارامترهای هدر و مستندات فنی ذیل به وب‌سرویس متصل شوید.

موجودی حساب

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

https://BASE_URL/v1/credit
GET

GET

                                {
                                      "token": "{TOKEN}"
                                }
                 

نمونه پاسخ :

                    {
                      "credit": 500000;
                      "currency": "IRR"
                    }
                
                    {
                      "code": 400,
                      "logRef": 1007,
                      "errorCode": "BadRequestException",
                      "message": "Invalid Client"
                    }
                

صورتحساب ها

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

https://BASE_URL/v1/invoice
GET

GET

                                {
                                      "token": "{TOKEN}"
                                }
                 

نمونه پاسخ :

                        [
                                  {
                                   "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"
                                  }
                        ]
                

لیست ابرها

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

https://BASE_URL/v1/cloud?perPage=10&page=1
GET

GET

                                {
                                      "token": "{TOKEN}"
                                }
                 

پارامترهای ورودی :

پارامترنوعتوضیح
perPageint تعداد آیتم های بازگشتی در درخواست با محدودیت ۱۰۰ عدد
pageintصفحه‌ی مورد نظر از اطلاعات

نمونه پاسخ :

                    {
                            "data": [
                               {
                                   "id": 61,
                                   "name": "arefsjd",
                                   "next_payment": "2022-06-27 17:00:00",
                                   "next_payment_amount": 1088000,
                                   "status": "terminated",
                                   "power_status": "off",
                                   "actions": [
                                       "start",
                                       "reboot"
                                   ]
                               },
                               {
                                   "id": 60,
                                   "name": "testVm",
                                   "next_payment": "2022-06-27 17:00:00",
                                   "next_payment_amount": 1328000,
                                   "status": "terminated",
                                   "power_status": "off",
                                   "actions": [
                                       "start",
                                       "reboot"
                                   ]
                               },
                               {
                                   "id": 59,
                                   "name": "arefsjd",
                                   "next_payment": "2022-06-29 18:00:00",
                                   "next_payment_amount": 1328000,
                                   "status": "terminated",
                                   "power_status": "off",
                                   "actions": [
                                       "start",
                                       "reboot"
                                   ]
                               },
                               {
                                   "id": 56,
                                   "name": "arefsjd",
                                   "next_payment": "2022-06-29 18:00:00",
                                   "next_payment_amount": 3445,
                                   "status": "waiting",
                                   "power_status": "off",
                                   "actions": [
                                       "start",
                                       "reboot"
                                   ]
                               }
                            ],
                            "pagination": {
                                "current_page": 2,
                                "total": 8,
                                "per_page": 4
                            }
                    }
                

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

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

https://BASE_URL/v1/cloud/action
POST

POST

                                {
                                      "token": "{TOKEN}"
                                }
                 
                                {
                                      vm_id: 0,
                                      action: "example"
                                }
                 

پارامترهای ورودی :

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

نمونه پاسخ :

                    "success"
                
                    {
                      "code": 400,
                      "logRef": 1007,
                      "errorCode": "BadRequestException",
                      "message": "این دستور برای این ابر قابل استفاده نمیباشد"
                    }
                
                    {
                      "code": 403,
                      "logRef": 2005,
                      "errorCode": "UnauthorizedException",
                      "message": "خطای دسترسی"
                    }
                
                    {
                      "code": 404,
                      "logRef": 101001,
                      "errorCode": "ModelNotFoundException",
                      "message": "مدل مورد نظر یافت نشد."
                    }