Введение English version | Последнее обновление: 17.05.2025

Авторизация

Авторизация с помощью API ключа используется в том случае, если необходим доступ к Вашему личному аккаунту. Такие запросы должны содержать следующие заголовки:

  • Authorization: Bearer {API Key} API ключ, строка

API ключ можно получить в самом боте (Профиль -> API)

Предупреждение

Доступ к API ключу должен быть только у Вас.

Взаимодействие с API

https://userapi.getdomain.sbs базовый URL

Content-Type: application/json для POST методов

Ошибки

Если запрос был обработан с ошибкой, то Вы получите результат в формате: 


 {
     "ok": false,
     "error_code": "EXAMPLE_ERROR"
 }

Код ошибки Описание
AUTHORIZATION_REQUIRED Требуется авторизация (недействительный API ключ, не передан заголовок)
REQUIRED_PARAMETRS_MISSED Отсутствуют необходимые параметры
USER_BANNED Постоянная блокировка в боте (обратитесь в поддержку для информации)
RATE_LIMIT Превышено максимальное количество запросов в минуту
REQUIRED_SUBSCRIPTION Для доступа требуется активная Prime подписка
INTERNAL_SERVER_ERROR Внутренняя ошибка сервера

Аккаунт

Данные об аккаунте

Возвращает краткую информацию о Вашем аккаунте.

Метод
GET /account/get

Параметры запроса
отсутствуют

Пример запроса
https://userapi.getdomain.sbs/account/get

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

 {
    "ok": true,
    "user_id": 1,
    "balance": 100,
    "ref_balance": 10
 }

Домены

Список доменных зон

Возвращает список доменных зон. Авторизация не требуется

Метод
GET /tlds/get

Параметры запроса
отсутствуют

Пример запроса
https://userapi.getdomain.sbs/tlds/get

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

 {
   "ok": true,
   "items": [
     {
	"text": "shop",
	"price": 5
     }
   ]
 }

Список Ваших доменов

Возвращает список активных доменов с Вашего аккаунта.

Метод
GET /domains/list

Параметры запроса
отсутствуют

Пример запроса
https://userapi.getdomain.sbs/domains/list

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

 {
   "ok": true,
   "items": [
     {
	"id": 1,
	"text": "example.com"
     }
   ]
 }

Данные о домене

Возвращает подробные данные об указанном домене.

Метод
GET /domains/get

Параметры запроса
Параметр Значение
domain_id Идентификатор домена integer

Пример запроса
https://userapi.getdomain.sbs/domains/get?domain_id=1

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

 {
     ok: true,
     id: 1,
     domain: "example.com",
     nameservers: ["ns1.test.com", "ns2.test.com"],
     main_record: "127.0.0.1",
     bans: {
         metamask: false,
         google: false
     },
     cloudflare: {
         ssl_status: false,
         security_level: "medium"
     }
 }

Зарегистрировать домен

Метод
POST /domains/register

Параметры запроса
Параметр Значение
domain Домен для регистрации string

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

 {
   "domain": "example.com"
 }

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

 {
   "ok": true,
   "domainId": 1
 }

Возможные ошибки
Параметр Значение
PURCHASE_UNAVAILABLE Домен недоступен для покупки
INSUFFICIENT_FUNDS Недостаточно средств для покупки
REGISTRATION_ERROR Ошибка при регистрации домена

NS записи

Обновить Nameservers

При передаче пустого массива в качестве Nameservers, будут применены наши.

Метод
POST /nameservers/update

Параметры запроса
Параметр Значение
domain_id Идентификатор домена integer
nameservers Массив строк с Nameservers array[string]

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

 {
   "domain_id": 1,
   "nameservers": ["ns1.test.com", "ns2.test.com"]
 }

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

 {
   "ok": true
 }

Возможные ошибки
Параметр Значение
DOMAIN_NOT_FOUND Домен не найден
TOO_MUCH_NAMESERVERS Превышено количество Nameservers. Максимум: 4
INCORRECT_NAMESERVERS Некорректные Nameservers
CANNOT_CHANGE_NAMESERVERS Не удалось сменить Nameservers, попробуйте позже.

Обновить NS запись

Обновление основной A записи для Вашего домена.

Метод
POST /nameservers/updateRecord

Параметры запроса
Параметр Значение
domain_id Идентификатор домена integer
content IP адрес string

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

 {
   "domain_id": 1,
   "content": "127.0.0.1"
 }

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

 {
   "ok": true
 }

Возможные ошибки
Параметр Значение
DOMAIN_NOT_FOUND Домен не найден
CANNOT_CHANGE_NS_RECORD Не удалось сменить NS запись, попробуйте позже.

Cloudflare

Включить/выключить SSL сертификат

Метод
POST /cloudflare/updateSSL

Параметры запроса
Параметр Значение
domain_id Идентификатор домена integer
status Включить или выключить SSL сертификат boolean

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

 {
   "domain_id": 1,
   "status": true
 }

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

 {
   "ok": true
 }

Возможные ошибки
Параметр Значение
DOMAIN_NOT_FOUND Домен не найден
CANNOT_CHANGE_STATUS Не удалось включить/выключить SSL сертификат. Попробуйте позже.

Выбрать уровень защиты

Метод
POST /nameservers/updateSecurityLevel

Параметры запроса
Параметр Значение
domain_id Идентификатор домена integer
level Уровень защиты (under_attack, high, medium, low, off) string

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

 {
   "domain_id": 1,
   "level": "off"
 }

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

 {
   "ok": true
 }

Возможные ошибки
Параметр Значение
DOMAIN_NOT_FOUND Домен не найден
CANNOT_CHANGE_SECURITY_LEVEL Не удалось сменить уровень защиты, попробуйте позже.