API предназначен для обеспечения взаимодействия партнеров с HB.BY. Аутентификация осуществляется по уникальному API-ключу (токену).
Взаимодействие осуществляется на клиент-серверной технологии RESTful. Партнер выступает в роли клиента, отправляет HTTP-запросы на сервер API. Данные передаются в кодировке UTF-8. В ответ на HTTP-запрос сервер отправляет HTTP-ответ клиенту в JSON-формате.
Для получения доступа к генерации API-токенов необходимо являться партнером HB.BY. После, в личном кабинете станет доступен раздел «API-токены».
Любой ответ от сервера представлен в JSON-формате. В случае успешного выполнения запроса возвращается необходимый набор ключей и значений, предназначенный для конкретного ответа на запрос.
Каждый метод указан в описании запроса.
Для запроса и ответа параметры оформлены в виде таблиц, где каждая строка описывает один параметр.
Платежи, счета и акты #
Получить список валют #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/currencies
Тело ответа:
Имя | Вложенность | Тип | Описание |
currencies | body | array«object*» | Список актов |
currency_id | currencies[i] | integer* | ID валюты |
currency_code | currencies[i] | string* | Код валюты |
currency_name | currencies[i] | string* | Название валюты |
Пример запроса:
// GET https://api.hb.by/v1/billing/currencies
Пример ответа:
{
"currencies": [
{
"currency_id": 200,
"currency_code": "USD",
"currency_name": "Доллар США"
},
{
"currency_id": 300,
"currency_code": "RUB",
"currency_name": "Российский рубль"
},
{
"currency_id": 400,
"currency_code": "EUR",
"currency_name": "Евро"
},
{
"currency_id": 500,
"currency_code": "BYN",
"currency_name": "Белорусский рубль"
}
]
}
Получить список прейскурантов #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/pricelists
Параметры запроса:
Имя | Вложенность | Тип | Описание |
as_of_date | query | string | От заданной даты |
Тело ответа:
Имя | Вложенность | Тип | Описание |
pricelists | body | array«object*» | Прейскурант |
number | pricelists[i] | string* | Номер |
description | pricelists[i] | string* | Описание |
as_of_date | pricelists[i] | string* | Дата |
Пример запроса:
// GET https://api.hb.by/v1/billing/pricelists?as_of_date=01.01.2025
Пример ответа:
{
"pricelists": [
{
"number": "1",
"description": "Тарифы на хостинг",
"as_of_date": "01.01.2025"
},
{
"number": "2",
"description": "Тарифы на домены",
"as_of_date": "04.09.2024"
},
{
"number": "3",
"description": "Тарифы на дополнительные услуги",
"as_of_date": "01.01.2024"
},
{
"number": "4",
"description": "Тарифы на SSL-сертификаты",
"as_of_date": "01.02.2024"
},
{
"number": "8",
"description": "Тарифы на электронную почту",
"as_of_date": "01.01.2024"
},
...
}
Получить список тарифов прейскуранта #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/pricelists/{number}/tariffs
Параметры запроса:
Имя | Вложенность | Тип | Описание |
number | path | integer* | Конкретный номер |
as_of_date | query | string | От заданной даты |
Тело ответа:
Имя | Вложенность | Тип | Описание |
number | body | integer* | Номер |
description | body | string* | Описание |
as_of_date | body | string* | Дата |
tariffs | body | array«object*» | Тарифы |
tariff_id | tariffs[i] | integer* | ID тарифа |
tariff_name | tariffs[i] | string* | Название тарифа |
service_id | tariffs[i] | string* | Общее имя услуги |
archived | tariffs[i] | boolean* | Архивирован |
period_type | tariffs[i] | string* | Период оплаты |
currency_id | tariffs[i] | integer* | Валюта |
prices | tariffs[i] | array«object*» | Стоимость |
period | tariffs[i].prices[i] | integer* | Период оплаты |
price | tariffs[i].prices[i] | number* | Стоимость |
Пример запроса:
// GET https://api.hb.by/v1/billing/pricelists/1/tariffs?as_of_date=01.01.2025
Пример ответа:
{
"number": 1,
"description": "Тарифы на хостинг",
"as_of_date": "01.01.2025",
"tariffs": [
{
"tariff_id": 100,
"tariff_name": "Домашний",
"service_id": "10",
"archived": true,
"period_type": "month",
"currency_id": 500,
"prices": [
{
"period": 1,
"price": 5.90
},
{
"period": 2,
"price": 11.80
},
{
"period": 3,
"price": 17.17
},
{
"period": 4,
"price": 22.66
},
{
"period": 5,
"price": 28.03
},
{
"period": 6,
"price": 33.63
},
{
"period": 12,
"price": 63.72
},
{
"period": 24,
"price": 120.36
},
{
"period": 36,
"price": 169.92
}
]
},
...
]
}
Получить список счетов #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/invoices
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_id | query | integer | ID заказа |
invoice_id | query | integer | ID счета |
Тело ответа:
Имя | Вложенность | Тип | Описание |
invoices | body | array«object*» | Список счетов |
invoice_id | invoices[i] | integer* | ID счета |
invoice_number | invoices[i] | string* | Номер счета |
order_id | invoices[i] | integer* | ID заказа |
creation_date | invoices[i] | string* | Дата формирования |
expiration_date | invoices[i] | string* | Дата истечения |
amount | invoices[i] | number* | Сумма счета |
currency_id | invoices[i] | integer* | Валюта |
state | invoices[i] | string* | Статус |
Пример запроса:
// GET https://api.hb.by/v1/billing/invoices?order_id=28877&invoice_id=99268
Пример ответа:
{
"invoices": [
{
"invoice_id": 99268,
"invoice_number": "СФ-1221379-02",
"order_id": 28877,
"creation_date": "28.08.2025",
"expiration_date": "27.09.2025",
"amount": 39.00,
"currency_id": 500,
"state": "WaitingForPayment"
}
]
}
Получить список платежей #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/payments
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_id | query | integer | ID заказа |
invoice_id | query | integer | ID счета |
Тело ответа:
Имя | Вложенность | Тип | Описание |
payments | body | array«object*» | Список платежей |
payment_id | payments[i] | integer* | ID платежа |
invoice_id | payments[i] | integer* | ID счета |
payment_date | payments[i] | string* | Дата платежа |
amount | payments[i] | number* | Сумма оплаты |
Пример запроса:
// GET https://api.hb.by/v1/billing/payments?invoice_id=99232
Пример ответа:
{
"payments": [
{
"payment_id": 57565,
"invoice_id": 99232,
"payment_date": "21.08.2025",
"amount": 6.00
}
]
}
Получить список актов #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/statements
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_id | query | integer | ID заказа |
statement_id | query | integer | ID акта |
Тело ответа:
Имя | Вложенность | Тип | Описание |
statements | body | array«object*» | Список актов |
statement_id | statements[i] | integer* | ID акта |
statement_number | statements[i] | string* | Номер акта |
order_id | statements[i] | integer* | ID заказа |
from_date | statements[i] | string* | Отчет от |
to_date | statements[i] | string* | Отчет по |
amount | statements[i] | number* | Сумма акта |
currency_id | statements[i] | integer* | Валюта |
Пример запроса:
// GET https://api.hb.by/v1/billing/statements?order_id=29426&statement_id=161708
Пример ответа:
{
"statements": [
{
"statement_id": 161708,
"statement_number": "ОУ-1221930-02",
"order_id": 29426,
"from_date": "01.04.2025",
"to_date": "23.07.2027",
"amount": 49.00,
"currency_id": 500
}
]
}
Получить список актов по партнерской программе #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/partner-statements
Параметры запроса:
Имя | Вложенность | Тип | Описание |
statement_id | query | integer | ID акта |
Тело ответа:
Имя | Вложенность | Тип | Описание |
partner_statements | body | array«object*» | Список актов |
partner_statement_id | partner_statements[i] | integer* | ID акта |
partner_statement_number | partner_statements[i] | string* | Номер акта |
from_date | partner_statements[i] | string* | Отчет от |
to_date | partner_statements[i] | string* | Отчет по |
Пример запроса:
// GET https://api.hb.by/v1/billing/partner-statements?statement_id=1062
Пример ответа:
{
"partner_statements": [
{
"partner_statement_id": 1062,
"partner_statement_number": "ОУ-ПД-16298-001",
"from_date": "01.07.2021",
"to_date": "31.07.2026"
}
]
}
Получить публичный URL счета #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/invoices/{id}/url
Параметры запроса:
Имя | Вложенность | Тип | Описание |
id | path | integer* | ID счета |
Тело ответа:
Имя | Вложенность | Тип | Описание |
url | body | string* | Url |
Пример запроса:
// GET https://api.hb.by/v1/billing/invoices/99268/url
Пример ответа:
{
"url": "https://hb.by/s/{some short url resource}"
}
Получить публичный URL акта #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/statements/{id}/url
Параметры запроса:
Имя | Вложенность | Тип | Описание |
id | path | integer* | ID акта |
Тело ответа:
Имя | Вложенность | Тип | Описание |
url | body | string* | Url |
Пример запроса:
// GET https://api.hb.by/v1/billing/statements/161708/url
Пример ответа:
{
"url": "https://hb.by/s/{some short url resource}"
}
Получить публичный URL партнерского акта #
Метод запроса: GET
Адрес: https://api.hb.by/v1/billing/partner-statements/{id}/url
Параметры запроса:
Имя | Вложенность | Тип | Описание |
id | path | integer* | ID акта |
Тело ответа:
Имя | Вложенность | Тип | Описание |
url | body | string* | Url |
Пример запроса:
// GET https://api.hb.by/v1/billing/partner-statements/1062/url
Пример ответа:
{
"url": "https://hb.by/s/{some short url resource}"
}
Заказы #
Структура запроса при оформления заказа #
Базовые поля (всегда)
Поля ниже указываются для любого заказа, независимо от типа заказчика.
Реквизиты по типам заказчика
Физическое лицо
Обязательно:
natural_person_requisites.last_name
– фамилия заказчика;
natural_person_requisites.first_name
– имя заказчика;
natural_person_requisites.middle_name
– отчество заказчика;
natural_person_requisites.address
– адрес заказчика.
Для доменов в зонах BY/БЕЛ/RU/SU/РФ дополнительно:
whois_person_requisites
– пасспортные данные администратора домена.
Шаблон:
{
"period_unit_count": 1,
"currency_id": 500,
"phone": "+375291234567",
"email": "user@mydomain.by",
"domain": "mydomain.by",
"natural_person_requisites": {
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"address": {
"postal_code": "220000",
"country_code": "BY",
"region": "Минская область",
"city": "Минск",
"street": "ул. Домбровская",
"building": "д. 9",
"room": "кв. 10"
}
},
"whois_person_requisites": {
"citizenship": "BY",
"series": "BM",
"number": "1234567",
"organization": "РОВД Октябрьского р-на г. Минска",
"identity_number": "1234567A901PB4",
"date_of_issue": "10.10.2005"
}
}
Индивидуальный предприниматель (ИП)
Обязательно:
individual_businessman_requisites.ucn
– УНП / ИНН;
individual_businessman_requisites.last_name
– фамилия заказчика;
individual_businessman_requisites.first_name
– имя заказчика;
individual_businessman_requisites.middle_name
– отчество заказчика;
individual_businessman_requisites.legal_address
– юридический адрес.
Необязательно, но рекомендуется:
individual_businessman_requisites.postal_address
– почтовый адрес (если не указан, то станет копией юридического);
individual_businessman_requisites.bank_requisites
– банковские реквизиты.
Для доменов в зонах BY/БЕЛ/RU/SU/РФ дополнительно:
whois_person_requisites
– пасспортные данные администратора домена;
whois_company_requisites
– данные организации-администратора домена.
Шаблон:
{
"period_unit_count": 1,
"currency_id": 500,
"phone": "+375291234567",
"email": "owner@mydomain.by",
"domain": "mydomain.by",
"individual_businessman_requisites": {
"ucn": "190123456",
"last_name": "Иванов",
"first_name": "Иван",
"middle_name": "Иванович",
"legal_address": {
"postal_code": "220000",
"country_code": "BY",
"region": "Минская область",
"city": "Минск",
"street": "ул. Ленина",
"building": "10",
"room": "оф. 5"
},
"postal_address": {
"postal_code": "220000",
"country_code": "BY",
"region": "Минская область",
"city": "Минск",
"street": "ул. Ленина",
"building": "10",
"room": "оф. 5"
},
"bank_requisites": {
"bank_name": "MyBank",
"swift": "MYBNBY22",
"iban": "BY00MYBN30120000000000000000"
}
},
"whois_person_requisites": {
"citizenship": "BY",
"series": "BM",
"number": "1234567",
"organization": "РОВД Октябрьского р-на г. Минска",
"identity_number": "1234567A901PB4",
"date_of_issue": "10.10.2005"
},
"whois_company_requisites": {
"registration_number": "123456789",
"registration_organization": "Мингорисполком",
"registration_issue_number": "0000001",
"registration_issue_date": "01.02.2020",
"is_government_company": false
}
}
Юридическое лицо
Обязательно:
juridical_person_requisites.ucn
– УНП / ИНН;
juridical_person_requisites.company_name
– полное наименование компании с указанием формы собственности;
juridical_person_requisites.executive_last_name
– фамилия руководителя;
juridical_person_requisites.executive_first_name
– имя руководителя;
juridical_person_requisites.executive_middle_name
– отчество руководителя;
juridical_person_requisites.post_of_executive
– должность руководителя;
juridical_person_requisites.legal_address
– юридический адрес.
Необязательно, но рекомендуется:
juridical_person_requisites.postal_address
– почтовый адрес (если не указан, то станет копией юридического);
juridical_person_requisites.bank_requisites
– банковские реквизиты.
Для доменов в зонах BY/БЕЛ/RU/SU/РФ дополнительно:
whois_company_requisites
– данные организации-администратора домена.
Шаблон:
{
"period_unit_count": 1,
"currency_id": 500,
"phone": "+375291234567",
"email": "it@mydomain.by",
"domain": "mydomain.by",
"juridical_person_requisites": {
"ucn": "190123456",
"company_name": "ООО «Компания»",
"executive_last_name": "Иванов",
"executive_first_name": "Иван",
"executive_middle_name": "Иванович",
"post_of_executive": "Директор",
"legal_address": {
"postal_code": "220000",
"country_code": "BY",
"region": "Минская область",
"city": "Минск",
"street": "пр. Победителей",
"building": "7",
"room": "оф. 101"
},
"postal_address": {
"postal_code": "220000",
"country_code": "BY",
"region": "Минская область",
"city": "Минск",
"street": "пр. Победителей",
"building": "7",
"room": "оф. 101"
},
"bank_requisites": {
"bank_name": "MyBank",
"swift": "MYBNBY22",
"iban": "BY00MYBN30120000000000000000"
}
},
"whois_company_requisites": {
"registration_number": "123456789",
"registration_organization": "Мингорисполком",
"registration_issue_number": "0000001",
"registration_issue_date": "01.02.2020",
"is_government_company": false
}
}
Метод запроса: POST
Адрес: https://api.hb.by/v1/orders/hostings
Получить заказы хостинга #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/hostings
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_number | query | string | Номер заказа |
order_id | query | integer | ID заказа |
from_order_date | query | string | С даты оформления |
to_order_date | query | string | По дату оформления |
service_id | query | integer | ID услуги |
Тело ответа:
Имя | Вложенность | Тип | Описание |
orders | body | array«object*» | Список заказов |
order_id | orders[i] | integer* | ID заказа |
service_id | orders[i] | integer* | ID услуги |
number | orders[i] | string* | Номер заказа |
state | orders[i] | string* | Статус услуги |
order_datetime | orders[i] | string* | Дата оформления заказа |
complete_date | orders[i] | string | Дата выполнения заказа |
expiration_date | orders[i] | string | Дата истечения заказа |
currency_id | orders[i] | integer* | ID валюты |
period_unit_type | orders[i] | string* | Тип периода оплаты |
period_unit_count | orders[i] | integer* | Количество единиц периода оплаты |
paid | orders[i] | boolean* | Статус оплаты |
completed | orders[i] | boolean* | Статус выполнения |
business_entity_type | orders[i] | string* | Тип заказчика в реквизитах |
advanced | orders[i] | object | Значение |
tariff_id | orders[i].advanced | integer | Тариф |
Пример запроса:
// GET https://api.hb.by/v1/orders/hostings
Пример ответа:
{
"orders": [
{
"order_id": 99999,
"service_id": 195,
"number": "СФ-1222161",
"state": "NewOrder",
"order_datetime": "10.10.2025 20:31",
"complete_date": null,
"expiration_date": null,
"currency_id": 500,
"period_unit_type": "month",
"period_unit_count": "1",
"paid": false,
"completed": false,
"business_entity_type": "NaturalPerson",
"advanced": {
"tariff_id": 566
}
},
...
]
}
Метод запроса: POST
Адрес: https://api.hb.by/v1/orders/corporate-mails
Получить заказы электронной почты #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/corporate-mails
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_number | query | string | Номер заказа |
order_id | query | integer | ID заказа |
from_order_date | query | string | С даты оформления |
to_order_date | query | string | По дату оформления |
Тело ответа:
Имя | Вложенность | Тип | Описание |
orders | body | array«object*» | Список заказов |
order_id | orders[i] | integer* | ID заказа |
service_id | orders[i] | integer* | ID услуги |
number | orders[i] | string* | Номер заказа |
state | orders[i] | string* | Статус услуги |
order_datetime | orders[i] | string* | Дата оформления заказа |
complete_date | orders[i] | string | Дата выполнения заказа |
expiration_date | orders[i] | string | Дата истечения заказа |
currency_id | orders[i] | integer* | ID валюты |
period_unit_type | orders[i] | string* | Тип периода оплаты |
period_unit_count | orders[i] | integer* | Количество единиц периода оплаты |
paid | orders[i] | boolean* | Статус оплаты |
completed | orders[i] | boolean* | Статус выполнения |
business_entity_type | orders[i] | string* | Тип заказчика в реквизитах |
advanced | orders[i] | object | Значение |
tariff_id | orders[i].advanced | integer | Тариф |
Пример запроса:
// GET https://api.hb.by/v1/orders/corporate-mails
Пример ответа:
{
"orders": [
{
"order_id": 99999,
"service_id": 150,
"number": "СФ-1222161",
"state": "NewOrder",
"order_datetime": "10.10.2025 20:31",
"complete_date": null,
"expiration_date": null,
"currency_id": 500,
"period_unit_type": "month",
"period_unit_count": "1",
"paid": false,
"completed": false,
"business_entity_type": "NaturalPerson",
"advanced": {
"tariff_id": 1805
}
},
...
]
}
Метод запроса: POST
Адрес: https://api.hb.by/v1/orders/ssl-certificates
Получить заказы SSL-сертификатов #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/ssl-certificates
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_number | query | string | Номер заказа |
order_id | query | integer | ID заказа |
from_order_date | query | string | С даты оформления |
to_order_date | query | string | По дату оформления |
Тело ответа:
Имя | Вложенность | Тип | Описание |
orders | body | array«object*» | Список заказов |
order_id | orders[i] | integer* | ID заказа |
service_id | orders[i] | integer* | ID услуги |
number | orders[i] | string* | Номер заказа |
state | orders[i] | string* | Статус услуги |
order_datetime | orders[i] | string* | Дата оформления заказа |
complete_date | orders[i] | string | Дата выполнения заказа |
expiration_date | orders[i] | string | Дата истечения заказа |
currency_id | orders[i] | integer* | ID валюты |
period_unit_type | orders[i] | string* | Тип периода оплаты |
period_unit_count | orders[i] | integer* | Количество единиц периода оплаты |
paid | orders[i] | boolean* | Статус оплаты |
completed | orders[i] | boolean* | Статус выполнения |
business_entity_type | orders[i] | string* | Тип заказчика в реквизитах |
advanced | orders[i] | object | Значение |
domain | orders[i].advanced | string | Домен |
use_csr | orders[i].advanced | boolean | Признак использования пользовательского CSR |
tariff_id | orders[i].advanced | integer | Тариф (наименование SSL-сертификата) |
valid_from_date | orders[i].advanced | string | Дата начала действия сертификата |
valid_till_date | orders[i].advanced | string | Дата окончания действия сертификата |
Пример запроса:
// GET https://api.hb.by/v1/orders/ssl-certificates
Пример ответа:
{
"orders": [
{
"order_id": 99999,
"service_id": 60,
"number": "СФ-1222161",
"state": "NewOrder",
"order_datetime": "10.10.2025 20:31",
"complete_date": null,
"expiration_date": null,
"currency_id": 500,
"period_unit_type": "year",
"period_unit_count": "1",
"paid": false,
"completed": false,
"business_entity_type": "NaturalPerson",
"advanced": {
"domain": "mydomain.by",
"use_csr": false,
"tariff_id": 7027,
"valid_from_date": null,
"valid_till_date": null
}
},
...
]
}
Метод запроса: POST
Адрес: https://api.hb.by/v1/orders/domains
Получить заказы доменов #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/domains
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_number | query | string | Номер заказа |
order_id | query | integer | ID заказа |
from_order_date | query | string | С даты оформления |
to_order_date | query | string | По дату оформления |
Тело ответа:
Имя | Вложенность | Тип | Описание |
orders | body | array«object*» | Список заказов |
order_id | orders[i] | integer* | ID заказа |
service_id | orders[i] | integer* | ID услуги |
number | orders[i] | string* | Номер заказа |
state | orders[i] | string* | Статус услуги |
order_datetime | orders[i] | string* | Дата оформления заказа |
complete_date | orders[i] | string | Дата выполнения заказа |
expiration_date | orders[i] | string | Дата истечения заказа |
currency_id | orders[i] | integer* | ID валюты |
period_unit_type | orders[i] | string* | Тип периода оплаты |
period_unit_count | orders[i] | integer* | Количество единиц периода оплаты |
paid | orders[i] | boolean* | Статус оплаты |
completed | orders[i] | boolean* | Статус выполнения |
business_entity_type | orders[i] | string* | Тип заказчика в реквизитах |
advanced | orders[i] | object | Значение |
domain | orders[i].advanced | string | Домен |
registered | orders[i].advanced | boolean | Признак регистрации |
renewed | orders[i].advanced | boolean | Признак продления |
registration_tariff_id | orders[i].advanced | integer | Привязанный тариф регистрации |
renew_tariff_id | orders[i].advanced | integer | Привязанный тариф продления |
Пример запроса:
// GET https://api.hb.by/v1/orders/domains
Пример ответа:
{
"orders": [
{
"order_id": 99999,
"service_id": 30,
"number": "СФ-1222161",
"state": "NewOrder",
"order_datetime": "10.10.2025 20:31",
"complete_date": null,
"expiration_date": null,
"currency_id": 500,
"period_unit_type": "year",
"period_unit_count": "1",
"paid": false,
"completed": false,
"business_entity_type": "NaturalPerson",
"advanced": {
"domain": "mydomain.by",
"registered": false,
"renewed": false,
"registration_tariff_id": 2000,
"renew_tariff_id": 2001
}
},
...
]
}
Получить доступные услуги #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/services
Тело ответа:
Имя | Вложенность | Тип | Описание |
services | body | array«object*» | Список услуг |
service_id | services[i] | string* | ID услуги |
canonical_name | services[i] | string* | Каноническое наименование |
name | services[i] | string* | Наименование |
Пример запроса:
// GET https://api.hb.by/v1/orders/services
Пример ответа:
{
"services": [
...
{
"service_id": 195,
"canonical_name": "UnixHosting",
"name": "Unix-хостинг"
},
...
]
}
Получить доступные тарифы хостинга #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/hostings/tariffs
Параметры запроса:
Имя | Вложенность | Тип | Описание |
currency_id | query | integer | ID валюты |
service_id | query | integer | ID услуги |
Тело ответа:
Имя | Вложенность | Тип | Описание |
tariffs | body | array«object*» | Список тарифов |
tariff_id | tariffs[i] | integer* | ID тарифа |
tariff_name | tariffs[i] | string* | Название тарифа |
service_id | tariffs[i] | string* | Общее имя услуги |
period_type | tariffs[i] | string* | Период оплаты |
prices | tariffs[i] | array«object*» | Стоимость |
period | tariffs[i].prices[i] | integer* | Период оплаты |
price | tariffs[i].prices[i] | number* | Стоимость |
Пример запроса:
// GET https://api.hb.by/v1/orders/hostings/tariffs?currency_id=500&service_id=195
Пример ответа:
{
"tariffs": [
{
"tariff_id": 566,
"tariff_name": "Unix Старт",
"service_id": 195,
"period_type": "month",
"prices": [
{
"period": 1,
"price": 6.00
},
...
]
},
...
]
}
Получить доступные тарифы электронной почты #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/corporate-mails/tariffs
Параметры запроса:
Имя | Вложенность | Тип | Описание |
currency_id | query | integer | ID валюты |
Тело ответа:
Имя | Вложенность | Тип | Описание |
tariffs | body | array«object*» | Список тарифов |
tariff_id | tariffs[i] | integer* | ID тарифа |
tariff_name | tariffs[i] | string* | Название тарифа |
service_id | tariffs[i] | string* | Общее имя услуги |
period_type | tariffs[i] | string* | Период оплаты |
prices | tariffs[i] | array«object*» | Стоимость |
period | tariffs[i].prices[i] | integer* | Период оплаты |
price | tariffs[i].prices[i] | number* | Стоимость |
Пример запроса:
// GET https://api.hb.by/v1/orders/corporate-mails/tariffs?currency_id=500
Пример ответа:
{
"tariffs": [
{
"tariff_id": 1805,
"tariff_name": "Почта-5",
"service_id": 150,
"period_type": "month",
"prices": [
{
"period": 1,
"price": 4.50
},
...
]
},
...
]
}
Получить доступные SSL-сертификаты #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/ssl-certificates/tariffs
Параметры запроса:
Имя | Вложенность | Тип | Описание |
currency_id | query | integer | ID валюты |
Тело ответа:
Имя | Вложенность | Тип | Описание |
tariffs | body | array«object*» | Список тарифов |
tariff_id | tariffs[i] | integer* | ID тарифа |
tariff_name | tariffs[i] | string* | Название тарифа |
service_id | tariffs[i] | string* | Общее имя услуги |
period_type | tariffs[i] | string* | Период оплаты |
prices | tariffs[i] | array«object*» | Стоимость |
period | tariffs[i].prices[i] | integer* | Период оплаты |
price | tariffs[i].prices[i] | number* | Стоимость |
Пример запроса:
// GET https://api.hb.by/v1/orders/ssl-certificates/tariffs?currency_id=500
Пример ответа:
{
"tariffs": [
{
"tariff_id": 7027,
"tariff_name": "GlobalSign AlphaSSL Domain",
"service_id": 60,
"period_type": "year",
"prices": [
{
"period": 1,
"price": 39.00
}
]
},
...
]
}
Получить доступные доменные зоны #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders/domains/zones
Параметры запроса:
Имя | Вложенность | Тип | Описание |
currency_id | query | integer | ID валюты |
Тело ответа:
Имя | Вложенность | Тип | Описание |
domain_zones | body | array«object*» | Список доменных зон |
domain_zone_id | domain_zones[i] | integer* | ID зоны |
name | domain_zones[i] | string* | Название зоны |
min_period | domain_zones[i] | integer* | Минимальный период заказа |
max_period | domain_zones[i] | integer* | Максимальный период заказа |
actual_registration_tariff_id | domain_zones[i] | integer* | ID тарифа регистрации |
registration_price | domain_zones[i] | number* | Стоимость регистрации |
actual_renew_tariff_id | domain_zones[i] | integer* | ID тарифа продления |
renew_price | domain_zones[i] | number* | Стоимость продления |
period_type | domain_zones[i] | string* | Период оплаты |
Пример запроса:
// GET https://api.hb.by/v1/orders/domains/zones?currency_id=500
Пример ответа:
{
"domain_zones": [
{
"domain_zone_id": 1,
"name": "by",
"min_period": 1,
"max_period": 2,
"actual_registration_tariff_id": 2000,
"registration_price": 33.00,
"actual_renew_tariff_id": 2001,
"renew_price": 33.00,
"period_type": "year"
},
...
]
}
Получить все заказы #
Метод запроса: GET
Адрес: https://api.hb.by/v1/orders
Параметры запроса:
Имя | Вложенность | Тип | Описание |
order_number | query | string | Номер заказа |
order_id | query | integer | ID заказа |
from_order_date | query | string | С даты оформления |
to_order_date | query | string | По дату оформления |
service_id | query | integer | ID услуги |
Тело ответа:
Имя | Вложенность | Тип | Описание |
orders | body | array«object*» | Список заказов |
order_id | orders[i] | integer* | ID заказа |
service_id | orders[i] | integer* | ID услуги |
number | orders[i] | string* | Номер заказа |
state | orders[i] | string* | Статус услуги |
order_datetime | orders[i] | string* | Дата оформления заказа |
complete_date | orders[i] | string | Дата выполнения заказа |
expiration_date | orders[i] | string | Дата истечения заказа |
currency_id | orders[i] | integer* | ID валюты |
period_unit_type | orders[i] | string* | Тип периода оплаты |
period_unit_count | orders[i] | integer* | Количество единиц периода оплаты |
paid | orders[i] | boolean* | Статус оплаты |
completed | orders[i] | boolean* | Статус выполнения |
business_entity_type | orders[i] | string* | Тип заказчика в реквизитах |
Пример запроса:
// GET https://api.hb.by/v1/orders
Пример ответа:
{
"orders": [
{
"order_id": 99999,
"service_id": 30,
"number": "СФ-1222161",
"state": "NewOrder",
"order_datetime": "10.10.2025 20:31",
"complete_date": null,
"expiration_date": null,
"currency_id": 500,
"period_unit_type": "year",
"period_unit_count": "1",
"paid": false,
"completed": false,
"business_entity_type": "NaturalPerson"
},
...
]
}
Домены #
Получить доступность одного или нескольких доменов #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/check
Тело запроса:
Имя | Вложенность | Тип | Описание |
domains | body | array«string*» | Домены |
- | body | string* | Значение |
Тело ответа:
Имя | Вложенность | Тип | Описание |
results | body | array«object*» | Результаты проверки |
domain | results[i] | string* | Домен |
is_available | results[i] | boolean* | Статус доступности |
is_premium | results[i] | boolean* | Статус премиальности |
state | results[i] | string* | Статус в реестре |
Пример запроса:
// POST https://api.hb.by/v1/domains/check
{
"domains": [
"hb.by"
]
}
Пример ответа:
{
"results": [
{
"domain": "hb.by",
"is_available": false,
"is_premium": false,
"state": "NotAvailable"
}
]
}
Получить сертификат владения доменом #
Метод запроса: GET
Адрес: https://api.hb.by/v1/domains/{orderId}/certificate
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело ответа:
Имя | Вложенность | Тип | Описание |
url | body | string* | Url |
Пример запроса:
// GET https://api.hb.by/v1/domains/29303/certificate
Пример ответа:
{
"url": "some url"
}
Получить список NS серверов домена #
Метод запроса: GET
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело ответа:
Имя | Вложенность | Тип | Описание |
servers | body | array«object*» | Список NS-серверов |
ns | servers[i] | string* | NS |
ip | servers[i] | string | IP |
Пример запроса:
// GET https://api.hb.by/v1/domains/29303/dns/servers
Пример ответа:
{
"servers": [
{
"ns": "ns1.hb.by",
"ip": null
},
{
"ns": "ns2.hb.by",
"ip": null
}
]
}
Удалить NS сервера домена #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/servers
Обновить список NS серверов домена на виртуальный хостинг #
Метод запроса: PUT
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers/hosting
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Пример запроса:
// PUT https://api.hb.by/v1/domains/29303/dns/servers/hosting
Обновить список NS серверов домена на расширенный редактор #
Метод запроса: PUT
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers/editor
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Пример запроса:
// PUT https://api.hb.by/v1/domains/29303/dns/servers/editor
Обновить список NS серверов домена на указанные #
Метод запроса: PUT
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers/custom
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
servers | body | array«object*» | Список NS-серверов |
ns | servers[i] | string* | NS |
ip | servers[i] | string | IP |
Пример запроса:
// PUT https://api.hb.by/v1/domains/29303/dns/servers/custom
{
"servers": [
{
"ns": "ns1.mydomain.by",
"ip": "100.100.100.100"
},
{
"ns": "ns2.mydomain.by",
"ip": "200.200.200.200"
}
]
}
Получить список DNS записей домена #
Метод запроса: GET
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело ответа:
Имя | Вложенность | Тип | Описание |
records | body | array«object*» | Список записей |
record_id | records[i] | integer* | ID записи |
type | records[i] | string* | Тип записи |
ttl | records[i] | integer* | Тип записи |
value | records[i] | string* | Значение |
Пример запроса:
// GET https://api.hb.by/v1/domains/29303/dns/records
Пример ответа:
{
"records": [
{
"record_id": 1000,
"type": "A",
"ttl": 86400,
"value": "www 100.100.100.100"
}
]
}
Добавить NS запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/ns
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
ns | body | string* | NS-сервер |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/ns
{
"ttl": 60,
"host": "ns1",
"ns": "ns1.mydomain.by"
}
Удалить NS запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/ns/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | Значение |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/ns/1000
Добавить A запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/a
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
ipv4 | body | string* | IPv4 |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/a
{
"ttl": 60,
"host": "www",
"ipv4": "100.100.100.100"
}
Удалить A запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/a/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | Значение |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/a/1000
Добавить AAAA запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/aaaa
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
ipv6 | body | string* | IPv4 |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/aaaa
{
"ttl": 60,
"host": "www6",
"ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}
Удалить AAAA запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/aaaa/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | Значение |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/aaaa/1000
Добавить CNAME запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/cname
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
canonical | body | string* | Каноническое имя |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/cname
{
"ttl": 60,
"host": "www",
"canonical": "mydomain.by"
}
Удалить CNAME запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/cname/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | ID записи |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/cname/1000
Добавить MX запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/mx
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
mail_server | body | string* | Почтовый сервер |
priority | body | integer* | Приоритет |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/mx
{
"ttl": 60,
"host": "ml",
"mail_server": "mail.mydomain.by",
"priority": 10
}
Удалить MX запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/mx/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | ID записи |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/mx/1000
Добавить TXT запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/txt
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
text | body | string* | Текстовое значение |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/txt
{
"ttl": 60,
"host": "_spf",
"text": "v=spf1 +mx +a -all"
}
Удалить TXT запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/txt/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | ID записи |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/txt/1000
Добавить SRV запись #
Метод запроса: POST
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/srv
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
Тело запроса:
Имя | Вложенность | Тип | Описание |
ttl | body | integer* | TTL |
host | body | string* | Хост (поддомен) |
service | body | string* | Сервис |
protocol | body | string* | Протокол |
target | body | string* | Цель |
port | body | integer* | Порт |
priority | body | integer* | Приоритет |
weight | body | integer* | Вес |
Пример запроса:
// POST https://api.hb.by/v1/domains/29303/dns/records/srv
{
"ttl": 60,
"host": "service",
"service": "sip",
"protocol": "tcp",
"target": "sipserver.mydomain.by",
"port": 5060,
"priority": 0,
"weight": 10
}
Удалить SRV запись #
Метод запроса: DELETE
Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/srv/{id}
Параметры запроса:
Имя | Вложенность | Тип | Описание |
orderId | path | integer* | ID заказа |
id | path | integer* | ID записи |
Пример запроса:
// DELETE https://api.hb.by/v1/domains/29303/dns/records/srv/1000