Главная
База знаний
Документация по API HB.BY

Документация по API HB.BY

Описание API #

API предназначен для обеспечения взаимодействия партнеров с HB.BY. Аутентификация осуществляется по уникальному API-ключу (токену).

Взаимодействие осуществляется на клиент-серверной технологии RESTful. Партнер выступает в роли клиента, отправляет HTTP-запросы на сервер API. Данные передаются в кодировке UTF-8. В ответ на HTTP-запрос сервер отправляет HTTP-ответ клиенту в JSON-формате.

Формат запроса #

Во всех запросах передаются обязательные параметры:

  • version – версия API;
  • x-api-token – API-ключ (токен) доступа к серверу.

Параметр version должен передаваться в строке запроса.

Параметр x-api-token должен передаваться в заголовке запроса.

Для получения доступа к генерации API-токенов необходимо являться партнером HB.BY. После, в личном кабинете станет доступен раздел «API-токены».

Формат ответа #

Любой ответ от сервера представлен в JSON-формате. В случае успешного выполнения запроса возвращается необходимый набор ключей и значений, предназначенный для конкретного ответа на запрос.

Пример ответа при успешном выполнении операции (получение списка счетов):

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

В случае ошибки валидации (код ответа 400) возвращается JSON, содержащий:

{
  "message": "Поле 'Домен' должно быть заполнено."
}

Возможные коды ошибок о выполнении операций:

  • 400 – некорректный запрос;
  • 401 – неавторизованный запрос;
  • 404 – метод или данные не найдены;
  • 500 – внутренняя ошибка сервера.

При успешном запросе возвращается 200 код ответа. Тело ответа в виде JSON возвращается в тех случаях, когда у метода указаны параметры ответа.

Структура документации #

Поддерживаемые методы

В API используются стандартные HTTP-методы:

  • GET – получение информации;
  • POST – создание или отправка данных;
  • PUT – полное обновление существующих данных;
  • DELETE – удаление данных.

Каждый метод указан в описании запроса.

Структура описания метода

Описание метода включает следующие разделы:

  • название и назначение метода – краткое описание действия;
  • метод и адрес запроса – указывается HTTP-метод и полный URL;
  • параметры запроса – список параметров, которые могут быть переданы в URL;
  • тело запроса – список параметров, которые могут быть переданы в формате JSON;
  • тело ответа – структура возвращаемых данных в формате JSON;
  • пример запроса – готовый пример вызова API;
  • пример ответа – пример JSON-объекта, который вернёт API.

Таблицы параметров

Для запроса и ответа параметры оформлены в виде таблиц, где каждая строка описывает один параметр.

  • Имя – название параметра.
  • Вложенность – путь параметра в структуре (например, body, pricelists[i]).
  • Тип – тип данных (например, string, integer, array«object»).
  • Описание – пояснение назначения параметра.

Обязательные параметры выделяются звёздочкой (*) рядом с типом.

Например:

  • string* – обязательный строковый параметр;
  • array«string*» – обязательный массив строк.

Если параметр не имеет звёздочки (*), то он считается необязательным, и может либо отсутствовать, либо иметь значение NULL.

Платежи, счета и акты #

Получить список валют #

Метод запроса: GET

Адрес: https://api.hb.by/v1/billing/currencies

Тело ответа:

ИмяВложенностьТипОписание
currenciesbodyarray«object*»Список актов
currency_idcurrencies[i]integer*ID валюты
currency_codecurrencies[i]string*Код валюты
currency_namecurrencies[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_datequerystringОт заданной даты

Тело ответа:

ИмяВложенностьТипОписание
pricelistsbodyarray«object*»Прейскурант
numberpricelists[i]string*Номер
descriptionpricelists[i]string*Описание
as_of_datepricelists[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

Параметры запроса:

ИмяВложенностьТипОписание
numberpathinteger*Конкретный номер
as_of_datequerystringОт заданной даты

Тело ответа:

ИмяВложенностьТипОписание
numberbodyinteger*Номер
descriptionbodystring*Описание
as_of_datebodystring*Дата
tariffsbodyarray«object*»Тарифы
tariff_idtariffs[i]integer*ID тарифа
tariff_nametariffs[i]string*Название тарифа
service_idtariffs[i]string*Общее имя услуги
archivedtariffs[i]boolean*Архивирован
period_typetariffs[i]string*Период оплаты
currency_idtariffs[i]integer*Валюта
pricestariffs[i]array«object*»Стоимость
periodtariffs[i]
.prices[i]		integer*Период оплаты
pricetariffs[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_idqueryintegerID заказа
invoice_idqueryintegerID счета

Тело ответа:

ИмяВложенностьТипОписание
invoicesbodyarray«object*»Список счетов
invoice_idinvoices[i]integer*ID счета
invoice_numberinvoices[i]string*Номер счета
order_idinvoices[i]integer*ID заказа
creation_dateinvoices[i]string*Дата формирования
expiration_dateinvoices[i]string*Дата истечения
amountinvoices[i]number*Сумма счета
currency_idinvoices[i]integer*Валюта
stateinvoices[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_idqueryintegerID заказа
invoice_idqueryintegerID счета

Тело ответа:

ИмяВложенностьТипОписание
paymentsbodyarray«object*»Список платежей
payment_idpayments[i]integer*ID платежа
invoice_idpayments[i]integer*ID счета
payment_datepayments[i]string*Дата платежа
amountpayments[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_idqueryintegerID заказа
statement_idqueryintegerID акта

Тело ответа:

ИмяВложенностьТипОписание
statementsbodyarray«object*»Список актов
statement_idstatements[i]integer*ID акта
statement_numberstatements[i]string*Номер акта
order_idstatements[i]integer*ID заказа
from_datestatements[i]string*Отчет от
to_datestatements[i]string*Отчет по
amountstatements[i]number*Сумма акта
currency_idstatements[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_idqueryintegerID акта

Тело ответа:

ИмяВложенностьТипОписание
partner_statementsbodyarray«object*»Список актов
partner_statement_idpartner_statements[i]integer*ID акта
partner_statement_numberpartner_statements[i]string*Номер акта
from_datepartner_statements[i]string*Отчет от
to_datepartner_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

Параметры запроса:

ИмяВложенностьТипОписание
idpathinteger*ID счета

Тело ответа:

ИмяВложенностьТипОписание
urlbodystring*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

Параметры запроса:

ИмяВложенностьТипОписание
idpathinteger*ID акта

Тело ответа:

ИмяВложенностьТипОписание
urlbodystring*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

Параметры запроса:

ИмяВложенностьТипОписание
idpathinteger*ID акта

Тело ответа:

ИмяВложенностьТипОписание
urlbodystring*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

Тело запроса:

ИмяВложенностьТипОписание
period_unit_countbodyintegerПериод оплаты
currency_idbodyintegerID валюты
phonebodystringТелефон
emailbodystringПочта
natural_person_requisitesbodyobjectЗначение
last_namenatural_person_requisitesstringФамилия заказчика
first_namenatural_person_requisitesstringИмя заказчика
middle_namenatural_person_requisitesstringОтчество заказчика
addressnatural_person_requisitesobjectЗначение
postal_codenatural_person_requisites
.address		string*Почтовый индекс
country_codenatural_person_requisites
.address		string*Страна
regionnatural_person_requisites
.address		string*Регион / Область
citynatural_person_requisites
.address		string*Населенный пункт
streetnatural_person_requisites
.address		string*Улица
buildingnatural_person_requisites
.address		string*Дом
roomnatural_person_requisites
.address		string*Помещение
individual_businessman_requisitesbodyobjectЗначение
ucnindividual_businessman_requisitesstringУНП / ИНН
legal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.legal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.legal_address		string*Страна
regionindividual_businessman_requisites
.legal_address		string*Регион / Область
cityindividual_businessman_requisites
.legal_address		string*Населенный пункт
streetindividual_businessman_requisites
.legal_address		string*Улица
buildingindividual_businessman_requisites
.legal_address		string*Дом
roomindividual_businessman_requisites
.legal_address		string*Помещение
postal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.postal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.postal_address		string*Страна
regionindividual_businessman_requisites
.postal_address		string*Регион / Область
cityindividual_businessman_requisites
.postal_address		string*Населенный пункт
streetindividual_businessman_requisites
.postal_address		string*Улица
buildingindividual_businessman_requisites
.postal_address		string*Дом
roomindividual_businessman_requisites
.postal_address		string*Помещение
bank_requisitesindividual_businessman_requisitesobjectЗначение
bank_nameindividual_businessman_requisites
.bank_requisites		stringНаименование банка
swiftindividual_businessman_requisites
.bank_requisites		stringБИК SWIFT
ibanindividual_businessman_requisites
.bank_requisites		stringIBAN
last_nameindividual_businessman_requisitesstringФамилия заказчика
first_nameindividual_businessman_requisitesstringИмя заказчика
middle_nameindividual_businessman_requisitesstringОтчество заказчика
juridical_person_requisitesbodyobjectЗначение
ucnjuridical_person_requisitesstringУНП / ИНН
legal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.legal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.legal_address		string*Страна
regionjuridical_person_requisites
.legal_address		string*Регион / Область
cityjuridical_person_requisites
.legal_address		string*Населенный пункт
streetjuridical_person_requisites
.legal_address		string*Улица
buildingjuridical_person_requisites
.legal_address		string*Дом
roomjuridical_person_requisites
.legal_address		string*Помещение
postal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.postal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.postal_address		string*Страна
regionjuridical_person_requisites
.postal_address		string*Регион / Область
cityjuridical_person_requisites
.postal_address		string*Населенный пункт
streetjuridical_person_requisites
.postal_address		string*Улица
buildingjuridical_person_requisites
.postal_address		string*Дом
roomjuridical_person_requisites
.postal_address		string*Помещение
bank_requisitesjuridical_person_requisitesobjectЗначение
bank_namejuridical_person_requisites
.bank_requisites		stringНаименование банка
swiftjuridical_person_requisites
.bank_requisites		stringБИК SWIFT
ibanjuridical_person_requisites
.bank_requisites		stringIBAN
company_namejuridical_person_requisitesstringПолное наименование организации
executive_last_namejuridical_person_requisitesstringФамилия руководителя
executive_first_namejuridical_person_requisitesstringИмя руководителя
executive_middle_namejuridical_person_requisitesstringОтчество руководителя
post_of_executivejuridical_person_requisitesstringДолжность руководителя
tariff_idbodyintegerID тарифа

Тело ответа:

ИмяВложенностьТипОписание
order_idbodyintegerID нового заказа
invoice_idbodyintegerID нового счета
invoice_urlbodystringПубличная короткая ссылка на счет

Пример запроса:

// POST https://api.hb.by/v1/orders/hostings
{
  "period_unit_count": 1,
  "currency_id": 500,
  "phone": "+375291234567",
  "email": "user@mydomain.by",
  "natural_person_requisites": {
    "address": {
      "postal_code": "220000",
      "country_code": "BY",
      "region": "Минская область",
      "city": "Минск",
      "street": "ул. Домбровская",
      "building": "д. 9",
      "room": "каб. 13.1.1"
    }
  },
  "tariff_id": 566
}

Пример ответа:

{
  "order_id": 99999,
  "invoice_id": 88888,
  "invoice_url": "https://hb.by/s/{some short url resource}"
}

Получить заказы хостинга #

Метод запроса: GET

Адрес: https://api.hb.by/v1/orders/hostings

Параметры запроса:

ИмяВложенностьТипОписание
order_numberquerystringНомер заказа
order_idqueryintegerID заказа
from_order_datequerystringС даты оформления
to_order_datequerystringПо дату оформления
service_idqueryintegerID услуги

Тело ответа:

ИмяВложенностьТипОписание
ordersbodyarray«object*»Список заказов
order_idorders[i]integer*ID заказа
service_idorders[i]integer*ID услуги
numberorders[i]string*Номер заказа
stateorders[i]string*Статус услуги
order_datetimeorders[i]string*Дата оформления заказа
complete_dateorders[i]stringДата выполнения заказа
expiration_dateorders[i]stringДата истечения заказа
currency_idorders[i]integer*ID валюты
period_unit_typeorders[i]string*Тип периода оплаты
period_unit_countorders[i]integer*Количество единиц периода оплаты
paidorders[i]boolean*Статус оплаты
completedorders[i]boolean*Статус выполнения
business_entity_typeorders[i]string*Тип заказчика в реквизитах
advancedorders[i]objectЗначение
tariff_idorders[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

Тело запроса:

ИмяВложенностьТипОписание
period_unit_countbodyintegerПериод оплаты
currency_idbodyintegerID валюты
phonebodystringТелефон
emailbodystringПочта
natural_person_requisitesbodyobjectЗначение
last_namenatural_person_requisitesstringФамилия заказчика
first_namenatural_person_requisitesstringИмя заказчика
middle_namenatural_person_requisitesstringОтчество заказчика
addressnatural_person_requisitesobjectЗначение
postal_codenatural_person_requisites
.address		string*Почтовый индекс
country_codenatural_person_requisites
.address		string*Страна
regionnatural_person_requisites
.address		string*Регион / Область
citynatural_person_requisites
.address		string*Населенный пункт
streetnatural_person_requisites
.address		string*Улица
buildingnatural_person_requisites
.address		string*Дом
roomnatural_person_requisites
.address		string*Помещение
individual_businessman_requisitesbodyobjectЗначение
ucnindividual_businessman_requisitesstringУНП / ИНН
legal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.legal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.legal_address		string*Страна
regionindividual_businessman_requisites
.legal_address		string*Регион / Область
cityindividual_businessman_requisites
.legal_address		string*Населенный пункт
streetindividual_businessman_requisites
.legal_address		string*Улица
buildingindividual_businessman_requisites
.legal_address		string*Дом
roomindividual_businessman_requisites
.legal_address		string*Помещение
postal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.postal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.postal_address		string*Страна
regionindividual_businessman_requisites
.postal_address		string*Регион / Область
cityindividual_businessman_requisites
.postal_address		string*Населенный пункт
streetindividual_businessman_requisites
.postal_address		string*Улица
buildingindividual_businessman_requisites
.postal_address		string*Дом
roomindividual_businessman_requisites
.postal_address		string*Помещение
bank_requisitesindividual_businessman_requisitesobjectЗначение
bank_nameindividual_businessman_requisites
.bank_requisites		stringНаименование банка
swiftindividual_businessman_requisites
.bank_requisites		stringБИК SWIFT
ibanindividual_businessman_requisites
.bank_requisites		stringIBAN
last_nameindividual_businessman_requisitesstringФамилия заказчика
first_nameindividual_businessman_requisitesstringИмя заказчика
middle_nameindividual_businessman_requisitesstringОтчество заказчика
juridical_person_requisitesbodyobjectЗначение
ucnjuridical_person_requisitesstringУНП / ИНН
legal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.legal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.legal_address		string*Страна
regionjuridical_person_requisites
.legal_address		string*Регион / Область
cityjuridical_person_requisites
.legal_address		string*Населенный пункт
streetjuridical_person_requisites
.legal_address		string*Улица
buildingjuridical_person_requisites
.legal_address		string*Дом
roomjuridical_person_requisites
.legal_address		string*Помещение
postal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.postal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.postal_address		string*Страна
regionjuridical_person_requisites
.postal_address		string*Регион / Область
cityjuridical_person_requisites
.postal_address		string*Населенный пункт
streetjuridical_person_requisites
.postal_address		string*Улица
buildingjuridical_person_requisites
.postal_address		string*Дом
roomjuridical_person_requisites
.postal_address		string*Помещение
bank_requisitesjuridical_person_requisitesobjectЗначение
bank_namejuridical_person_requisites
.bank_requisites		stringНаименование банка
swiftjuridical_person_requisites
.bank_requisites		stringБИК SWIFT
ibanjuridical_person_requisites
.bank_requisites		stringIBAN
company_namejuridical_person_requisitesstringПолное наименование организации
executive_last_namejuridical_person_requisitesstringФамилия руководителя
executive_first_namejuridical_person_requisitesstringИмя руководителя
executive_middle_namejuridical_person_requisitesstringОтчество руководителя
post_of_executivejuridical_person_requisitesstringДолжность руководителя
tariff_idbodyinteger*ID тарифа

Тело ответа:

ИмяВложенностьТипОписание
order_idbodyintegerID нового заказа
invoice_idbodyintegerID нового счета
invoice_urlbodystringПубличная короткая ссылка на счет

Пример запроса:

// POST https://api.hb.by/v1/orders/corporate-mails
{
  "period_unit_count": 1,
  "currency_id": 500,
  "phone": "+375291234567",
  "email": "user@mydomain.by",
  "natural_person_requisites": {
    "address": {
      "postal_code": "220000",
      "country_code": "BY",
      "region": "Минская область",
      "city": "Минск",
      "street": "ул. Домбровская",
      "building": "д. 9",
      "room": "каб. 13.1.1"
    }
  },
  "tariff_id": 1805
}

Пример ответа:

{
  "order_id": 99999,
  "invoice_id": 88888,
  "invoice_url": "https://hb.by/s/{some short url resource}"
}

Получить заказы электронной почты #

Метод запроса: GET

Адрес: https://api.hb.by/v1/orders/corporate-mails

Параметры запроса:

ИмяВложенностьТипОписание
order_numberquerystringНомер заказа
order_idqueryintegerID заказа
from_order_datequerystringС даты оформления
to_order_datequerystringПо дату оформления

Тело ответа:

ИмяВложенностьТипОписание
ordersbodyarray«object*»Список заказов
order_idorders[i]integer*ID заказа
service_idorders[i]integer*ID услуги
numberorders[i]string*Номер заказа
stateorders[i]string*Статус услуги
order_datetimeorders[i]string*Дата оформления заказа
complete_dateorders[i]stringДата выполнения заказа
expiration_dateorders[i]stringДата истечения заказа
currency_idorders[i]integer*ID валюты
period_unit_typeorders[i]string*Тип периода оплаты
period_unit_countorders[i]integer*Количество единиц периода оплаты
paidorders[i]boolean*Статус оплаты
completedorders[i]boolean*Статус выполнения
business_entity_typeorders[i]string*Тип заказчика в реквизитах
advancedorders[i]objectЗначение
tariff_idorders[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
      }
    },
    ...
  ]
}

Оформить заказ SSL-сертификата #

Метод запроса: POST

Адрес: https://api.hb.by/v1/orders/ssl-certificates

Тело запроса:

ИмяВложенностьТипОписание
period_unit_countbodyintegerПериод оплаты
currency_idbodyintegerID валюты
phonebodystringТелефон
emailbodystringПочта
natural_person_requisitesbodyobjectЗначение
last_namenatural_person_requisitesstringФамилия заказчика
first_namenatural_person_requisitesstringИмя заказчика
middle_namenatural_person_requisitesstringОтчество заказчика
addressnatural_person_requisitesobjectЗначение
postal_codenatural_person_requisites
.address		string*Почтовый индекс
country_codenatural_person_requisites
.address		string*Страна
regionnatural_person_requisites
.address		string*Регион / Область
citynatural_person_requisites
.address		string*Населенный пункт
streetnatural_person_requisites
.address		string*Улица
buildingnatural_person_requisites
.address		string*Дом
roomnatural_person_requisites
.address		string*Помещение
individual_businessman_requisitesbodyobjectЗначение
ucnindividual_businessman_requisitesstringУНП / ИНН
legal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.legal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.legal_address		string*Страна
regionindividual_businessman_requisites
.legal_address		string*Регион / Область
cityindividual_businessman_requisites
.legal_address		string*Населенный пункт
streetindividual_businessman_requisites
.legal_address		string*Улица
buildingindividual_businessman_requisites
.legal_address		string*Дом
roomindividual_businessman_requisites
.legal_address		string*Помещение
postal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.postal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.postal_address		string*Страна
regionindividual_businessman_requisites
.postal_address		string*Регион / Область
cityindividual_businessman_requisites
.postal_address		string*Населенный пункт
streetindividual_businessman_requisites
.postal_address		string*Улица
buildingindividual_businessman_requisites
.postal_address		string*Дом
roomindividual_businessman_requisites
.postal_address		string*Помещение
bank_requisitesindividual_businessman_requisitesobjectЗначение
bank_nameindividual_businessman_requisites
.bank_requisites		stringНаименование банка
swiftindividual_businessman_requisites
.bank_requisites		stringБИК SWIFT
ibanindividual_businessman_requisites
.bank_requisites		stringIBAN
last_nameindividual_businessman_requisitesstringФамилия заказчика
first_nameindividual_businessman_requisitesstringИмя заказчика
middle_nameindividual_businessman_requisitesstringОтчество заказчика
juridical_person_requisitesbodyobjectЗначение
ucnjuridical_person_requisitesstringУНП / ИНН
legal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.legal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.legal_address		string*Страна
regionjuridical_person_requisites
.legal_address		string*Регион / Область
cityjuridical_person_requisites
.legal_address		string*Населенный пункт
streetjuridical_person_requisites
.legal_address		string*Улица
buildingjuridical_person_requisites
.legal_address		string*Дом
roomjuridical_person_requisites
.legal_address		string*Помещение
postal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.postal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.postal_address		string*Страна
regionjuridical_person_requisites
.postal_address		string*Регион / Область
cityjuridical_person_requisites
.postal_address		string*Населенный пункт
streetjuridical_person_requisites
.postal_address		string*Улица
buildingjuridical_person_requisites
.postal_address		string*Дом
roomjuridical_person_requisites
.postal_address		string*Помещение
bank_requisitesjuridical_person_requisitesobjectЗначение
bank_namejuridical_person_requisites
.bank_requisites		stringНаименование банка
swiftjuridical_person_requisites
.bank_requisites		stringБИК SWIFT
ibanjuridical_person_requisites
.bank_requisites		stringIBAN
company_namejuridical_person_requisitesstringПолное наименование организации
executive_last_namejuridical_person_requisitesstringФамилия руководителя
executive_first_namejuridical_person_requisitesstringИмя руководителя
executive_middle_namejuridical_person_requisitesstringОтчество руководителя
post_of_executivejuridical_person_requisitesstringДолжность руководителя
tariff_idbodyinteger*ID тарифа
domainbodystringДомен
csrbodystringCSR

Тело ответа:

ИмяВложенностьТипОписание
order_idbodyintegerID нового заказа
invoice_idbodyintegerID нового счета
invoice_urlbodystringПубличная короткая ссылка на счет

Пример запроса:

// POST https://api.hb.by/v1/orders/ssl-certificates
{
  "period_unit_count": 1,
  "currency_id": 500,
  "phone": "+375291234567",
  "email": "user@mydomain.by",
  "natural_person_requisites": {
    "address": {
      "postal_code": "220000",
      "country_code": "BY",
      "region": "Минская область",
      "city": "Минск",
      "street": "ул. Домбровская",
      "building": "д. 9",
      "room": "каб. 13.1.1"
    }
  },
  "tariff_id": 7027,
  "domain": "mydomain.by"
}

Пример ответа:

{
  "order_id": 99999,
  "invoice_id": 88888,
  "invoice_url": "https://hb.by/s/{some short url resource}"
}

Получить заказы SSL-сертификатов #

Метод запроса: GET

Адрес: https://api.hb.by/v1/orders/ssl-certificates

Параметры запроса:

ИмяВложенностьТипОписание
order_numberquerystringНомер заказа
order_idqueryintegerID заказа
from_order_datequerystringС даты оформления
to_order_datequerystringПо дату оформления

Тело ответа:

ИмяВложенностьТипОписание
ordersbodyarray«object*»Список заказов
order_idorders[i]integer*ID заказа
service_idorders[i]integer*ID услуги
numberorders[i]string*Номер заказа
stateorders[i]string*Статус услуги
order_datetimeorders[i]string*Дата оформления заказа
complete_dateorders[i]stringДата выполнения заказа
expiration_dateorders[i]stringДата истечения заказа
currency_idorders[i]integer*ID валюты
period_unit_typeorders[i]string*Тип периода оплаты
period_unit_countorders[i]integer*Количество единиц периода оплаты
paidorders[i]boolean*Статус оплаты
completedorders[i]boolean*Статус выполнения
business_entity_typeorders[i]string*Тип заказчика в реквизитах
advancedorders[i]objectЗначение
domainorders[i]
.advanced		stringДомен
use_csrorders[i]
.advanced		booleanПризнак использования пользовательского CSR
tariff_idorders[i]
.advanced		integerТариф (наименование SSL-сертификата)
valid_from_dateorders[i]
.advanced		stringДата начала действия сертификата
valid_till_dateorders[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

Тело запроса:

ИмяВложенностьТипОписание
period_unit_countbodyintegerПериод оплаты
currency_idbodyintegerID валюты
phonebodystringТелефон
emailbodystringПочта
natural_person_requisitesbodyobjectЗначение
last_namenatural_person_requisitesstringФамилия заказчика
first_namenatural_person_requisitesstringИмя заказчика
middle_namenatural_person_requisitesstringОтчество заказчика
addressnatural_person_requisitesobjectЗначение
postal_codenatural_person_requisites
.address		string*Почтовый индекс
country_codenatural_person_requisites
.address		string*Страна
regionnatural_person_requisites
.address		string*Регион / Область
citynatural_person_requisites
.address		string*Населенный пункт
streetnatural_person_requisites
.address		string*Улица
buildingnatural_person_requisites
.address		string*Дом
roomnatural_person_requisites
.address		string*Помещение
individual_businessman_requisitesbodyobjectЗначение
ucnindividual_businessman_requisitesstringУНП / ИНН
legal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.legal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.legal_address		string*Страна
regionindividual_businessman_requisites
.legal_address		string*Регион / Область
cityindividual_businessman_requisites
.legal_address		string*Населенный пункт
streetindividual_businessman_requisites
.legal_address		string*Улица
buildingindividual_businessman_requisites
.legal_address		string*Дом
roomindividual_businessman_requisites
.legal_address		string*Помещение
postal_addressindividual_businessman_requisitesobjectЗначение
postal_codeindividual_businessman_requisites
.postal_address		string*Почтовый индекс
country_codeindividual_businessman_requisites
.postal_address		string*Страна
regionindividual_businessman_requisites
.postal_address		string*Регион / Область
cityindividual_businessman_requisites
.postal_address		string*Населенный пункт
streetindividual_businessman_requisites
.postal_address		string*Улица
buildingindividual_businessman_requisites
.postal_address		string*Дом
roomindividual_businessman_requisites
.postal_address		string*Помещение
bank_requisitesindividual_businessman_requisitesobjectЗначение
bank_nameindividual_businessman_requisites
.bank_requisites		stringНаименование банка
swiftindividual_businessman_requisites
.bank_requisites		stringБИК SWIFT
ibanindividual_businessman_requisites
.bank_requisites		stringIBAN
last_nameindividual_businessman_requisitesstringФамилия заказчика
first_nameindividual_businessman_requisitesstringИмя заказчика
middle_nameindividual_businessman_requisitesstringОтчество заказчика
juridical_person_requisitesbodyobjectЗначение
ucnjuridical_person_requisitesstringУНП / ИНН
legal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.legal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.legal_address		string*Страна
regionjuridical_person_requisites
.legal_address		string*Регион / Область
cityjuridical_person_requisites
.legal_address		string*Населенный пункт
streetjuridical_person_requisites
.legal_address		string*Улица
buildingjuridical_person_requisites
.legal_address		string*Дом
roomjuridical_person_requisites
.legal_address		string*Помещение
postal_addressjuridical_person_requisitesobjectЗначение
postal_codejuridical_person_requisites
.postal_address		string*Почтовый индекс
country_codejuridical_person_requisites
.postal_address		string*Страна
regionjuridical_person_requisites
.postal_address		string*Регион / Область
cityjuridical_person_requisites
.postal_address		string*Населенный пункт
streetjuridical_person_requisites
.postal_address		string*Улица
buildingjuridical_person_requisites
.postal_address		string*Дом
roomjuridical_person_requisites
.postal_address		string*Помещение
bank_requisitesjuridical_person_requisitesobjectЗначение
bank_namejuridical_person_requisites
.bank_requisites		stringНаименование банка
swiftjuridical_person_requisites
.bank_requisites		stringБИК SWIFT
ibanjuridical_person_requisites
.bank_requisites		stringIBAN
company_namejuridical_person_requisitesstringПолное наименование организации
executive_last_namejuridical_person_requisitesstringФамилия руководителя
executive_first_namejuridical_person_requisitesstringИмя руководителя
executive_middle_namejuridical_person_requisitesstringОтчество руководителя
post_of_executivejuridical_person_requisitesstringДолжность руководителя
domainbodystringДомен
whois_person_requisitesbodyobjectЗначение
citizenshipwhois_person_requisitesstringГражданство (код страны)
serieswhois_person_requisitesstringСерия
numberwhois_person_requisitesstringНомер
organizationwhois_person_requisitesstringКем выдан
identity_numberwhois_person_requisitesstringИдентификационный номер
date_of_issuewhois_person_requisitesstringДата выдачи
date_of_birthwhois_person_requisitesstringДата рождения (только для RU/SU/РФ)
whois_company_requisitesbodyobjectЗначение
registration_numberwhois_company_requisitesstringРегистрационный номер (только для BY/БЕЛ)
registration_organizationwhois_company_requisitesstringОрган, осуществивший регистрацию (только для BY/БЕЛ)
registration_issue_numberwhois_company_requisitesstringНомер решения о государственной регистрации (только для BY/БЕЛ)
registration_issue_datewhois_company_requisitesstringДата решения о государственной регистрации (только для BY/БЕЛ)
is_government_companywhois_company_requisitesbooleanГосударственная организация (только для BY/БЕЛ)
innwhois_company_requisitesstringИНН (только для RU/SU/РФ)
kppwhois_company_requisitesstringКПП (только для RU/SU/РФ)
ogrnwhois_company_requisitesstringОГРН (только для RU/SU/РФ)

Тело ответа:

ИмяВложенностьТипОписание
order_idbodyintegerID нового заказа
invoice_idbodyintegerID нового счета
invoice_urlbodystringПубличная короткая ссылка на счет

Пример запроса:

// POST https://api.hb.by/v1/orders/domains
{
  "period_unit_count": 1,
  "currency_id": 500,
  "phone": "+375291234567",
  "email": "user@mydomain.by",
  "natural_person_requisites": {
    "address": {
      "postal_code": "220000",
      "country_code": "BY",
      "region": "Минская область",
      "city": "Минск",
      "street": "ул. Домбровская",
      "building": "д. 9",
      "room": "каб. 13.1.1"
    }
  },
  "domain": "mydomain.by",
  "whois_person_requisites": {
    "citizenship": "BY",
    "series": "BM",
    "number": "1234567",
    "organization": "РОВД Октябрьского р-на г. Минска",
    "identity_number": "1234567A901PB4",
    "date_of_issue": "10.10.2005"
  }
}

Пример ответа:

{
  "order_id": 99999,
  "invoice_id": 88888,
  "invoice_url": "https://hb.by/s/{some short url resource}"
}

Получить заказы доменов #

Метод запроса: GET

Адрес: https://api.hb.by/v1/orders/domains

Параметры запроса:

ИмяВложенностьТипОписание
order_numberquerystringНомер заказа
order_idqueryintegerID заказа
from_order_datequerystringС даты оформления
to_order_datequerystringПо дату оформления

Тело ответа:

ИмяВложенностьТипОписание
ordersbodyarray«object*»Список заказов
order_idorders[i]integer*ID заказа
service_idorders[i]integer*ID услуги
numberorders[i]string*Номер заказа
stateorders[i]string*Статус услуги
order_datetimeorders[i]string*Дата оформления заказа
complete_dateorders[i]stringДата выполнения заказа
expiration_dateorders[i]stringДата истечения заказа
currency_idorders[i]integer*ID валюты
period_unit_typeorders[i]string*Тип периода оплаты
period_unit_countorders[i]integer*Количество единиц периода оплаты
paidorders[i]boolean*Статус оплаты
completedorders[i]boolean*Статус выполнения
business_entity_typeorders[i]string*Тип заказчика в реквизитах
advancedorders[i]objectЗначение
domainorders[i]
.advanced		stringДомен
registeredorders[i]
.advanced		booleanПризнак регистрации
renewedorders[i]
.advanced		booleanПризнак продления
registration_tariff_idorders[i]
.advanced		integerПривязанный тариф регистрации
renew_tariff_idorders[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

Тело ответа:

ИмяВложенностьТипОписание
servicesbodyarray«object*»Список услуг
service_idservices[i]string*ID услуги
canonical_nameservices[i]string*Каноническое наименование
nameservices[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_idqueryintegerID валюты
service_idqueryintegerID услуги

Тело ответа:

ИмяВложенностьТипОписание
tariffsbodyarray«object*»Список тарифов
tariff_idtariffs[i]integer*ID тарифа
tariff_nametariffs[i]string*Название тарифа
service_idtariffs[i]string*Общее имя услуги
period_typetariffs[i]string*Период оплаты
pricestariffs[i]array«object*»Стоимость
periodtariffs[i]
.prices[i]		integer*Период оплаты
pricetariffs[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_idqueryintegerID валюты

Тело ответа:

ИмяВложенностьТипОписание
tariffsbodyarray«object*»Список тарифов
tariff_idtariffs[i]integer*ID тарифа
tariff_nametariffs[i]string*Название тарифа
service_idtariffs[i]string*Общее имя услуги
period_typetariffs[i]string*Период оплаты
pricestariffs[i]array«object*»Стоимость
periodtariffs[i]
.prices[i]		integer*Период оплаты
pricetariffs[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_idqueryintegerID валюты

Тело ответа:

ИмяВложенностьТипОписание
tariffsbodyarray«object*»Список тарифов
tariff_idtariffs[i]integer*ID тарифа
tariff_nametariffs[i]string*Название тарифа
service_idtariffs[i]string*Общее имя услуги
period_typetariffs[i]string*Период оплаты
pricestariffs[i]array«object*»Стоимость
periodtariffs[i]
.prices[i]		integer*Период оплаты
pricetariffs[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_idqueryintegerID валюты

Тело ответа:

ИмяВложенностьТипОписание
domain_zonesbodyarray«object*»Список доменных зон
domain_zone_iddomain_zones[i]integer*ID зоны
namedomain_zones[i]string*Название зоны
min_perioddomain_zones[i]integer*Минимальный период заказа
max_perioddomain_zones[i]integer*Максимальный период заказа
actual_registration_tariff_iddomain_zones[i]integer*ID тарифа регистрации
registration_pricedomain_zones[i]number*Стоимость регистрации
actual_renew_tariff_iddomain_zones[i]integer*ID тарифа продления
renew_pricedomain_zones[i]number*Стоимость продления
period_typedomain_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_numberquerystringНомер заказа
order_idqueryintegerID заказа
from_order_datequerystringС даты оформления
to_order_datequerystringПо дату оформления
service_idqueryintegerID услуги

Тело ответа:

ИмяВложенностьТипОписание
ordersbodyarray«object*»Список заказов
order_idorders[i]integer*ID заказа
service_idorders[i]integer*ID услуги
numberorders[i]string*Номер заказа
stateorders[i]string*Статус услуги
order_datetimeorders[i]string*Дата оформления заказа
complete_dateorders[i]stringДата выполнения заказа
expiration_dateorders[i]stringДата истечения заказа
currency_idorders[i]integer*ID валюты
period_unit_typeorders[i]string*Тип периода оплаты
period_unit_countorders[i]integer*Количество единиц периода оплаты
paidorders[i]boolean*Статус оплаты
completedorders[i]boolean*Статус выполнения
business_entity_typeorders[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

Тело запроса:

ИмяВложенностьТипОписание
domainsbodyarray«string*»Домены
-bodystring*Значение

Тело ответа:

ИмяВложенностьТипОписание
resultsbodyarray«object*»Результаты проверки
domainresults[i]string*Домен
is_availableresults[i]boolean*Статус доступности
is_premiumresults[i]boolean*Статус премиальности
stateresults[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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело ответа:

ИмяВложенностьТипОписание
urlbodystring*Url

Пример запроса:

// GET https://api.hb.by/v1/domains/29303/certificate

Пример ответа:

{
  "url": "some url"
}

Получить список NS серверов домена #

Метод запроса: GET

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело ответа:

ИмяВложенностьТипОписание
serversbodyarray«object*»Список NS-серверов
nsservers[i]string*NS
ipservers[i]stringIP

Пример запроса:

// 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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Пример запроса:

// DELETE https://api.hb.by/v1/domains/29303/dns/servers

Обновить список NS серверов домена на виртуальный хостинг #

Метод запроса: PUT

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers/hosting

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Пример запроса:

// PUT https://api.hb.by/v1/domains/29303/dns/servers/hosting

Обновить список NS серверов домена на расширенный редактор #

Метод запроса: PUT

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers/editor

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Пример запроса:

// PUT https://api.hb.by/v1/domains/29303/dns/servers/editor

Обновить список NS серверов домена на указанные #

Метод запроса: PUT

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/servers/custom

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
serversbodyarray«object*»Список NS-серверов
nsservers[i]string*NS
ipservers[i]stringIP

Пример запроса:

// 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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело ответа:

ИмяВложенностьТипОписание
recordsbodyarray«object*»Список записей
record_idrecords[i]integer*ID записи
typerecords[i]string*Тип записи
ttlrecords[i]integer*Тип записи
valuerecords[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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
nsbodystring*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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*Значение

Пример запроса:

// DELETE https://api.hb.by/v1/domains/29303/dns/records/ns/1000

Добавить A запись #

Метод запроса: POST

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/a

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
ipv4bodystring*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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*Значение

Пример запроса:

// DELETE https://api.hb.by/v1/domains/29303/dns/records/a/1000

Добавить AAAA запись #

Метод запроса: POST

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/aaaa

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
ipv6bodystring*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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*Значение

Пример запроса:

// DELETE https://api.hb.by/v1/domains/29303/dns/records/aaaa/1000

Добавить CNAME запись #

Метод запроса: POST

Адрес: https://api.hb.by/v1/domains/{orderId}/dns/records/cname

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
canonicalbodystring*Каноническое имя

Пример запроса:

// 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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
mail_serverbodystring*Почтовый сервер
prioritybodyinteger*Приоритет

Пример запроса:

// 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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
textbodystring*Текстовое значение

Пример запроса:

// 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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*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

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа

Тело запроса:

ИмяВложенностьТипОписание
ttlbodyinteger*TTL
hostbodystring*Хост (поддомен)
servicebodystring*Сервис
protocolbodystring*Протокол
targetbodystring*Цель
portbodyinteger*Порт
prioritybodyinteger*Приоритет
weightbodyinteger*Вес

Пример запроса:

// 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}

Параметры запроса:

ИмяВложенностьТипОписание
orderIdpathinteger*ID заказа
idpathinteger*ID записи

Пример запроса:

// DELETE https://api.hb.by/v1/domains/29303/dns/records/srv/1000
  1. Описание API
  2. Платежи, счета и акты
  3. Заказы
  4. Домены