Документация BILLmanager 6
Документация
/
Документация BILLmanager 6
/
Разработчику
/
BILLmanager API
/
Домены (domain)

Домены (domain)

domain

Результат: список элементов

Домены

Уровень доступа: admin user

ПараметрЗначение
idId
domain Имя домена
account Клиент
pricelist Тариф
project Провайдер
processingmodule Модуль обработки
createdateДата создания
expiredate Действует до
status_msg 
item_status статус услуги. Может принимать значения: 
  • 1 — заказана; 
  • 2 — активна; 
  • 3 — остановлена;
  • 4 — удалена; 
  • 5 — обрабатывается; 
costСтоимость

Информация о домене

Функция: domain.whois

Уровень доступа: admin user

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
whois_data Информация о домене. WHOIS информация о домене

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

Функция: domain.order.register

Уровень доступа: user

Включить

Функция: domain.resume

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Открытие услуги

Функция: domain.open

Уровень доступа: admin

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
processingmodule Модуль обработки, назначенный услуге

Серверы имен

Функция: domain.ns

Уровень доступа: admin user

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

ПараметрЗначение
ns0NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
ns1NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
ns2 NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
ns3NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2"
ns_additionalДополнительные NS. Фомат записи "ns.example.com" или "ns.example.com/1.1.1.1" или "ns.example.com/1.1.1.1,2.2.2.2". Каждый дополнительный сервер имен указывается с новой строки
provider 

Установить фильтр по клиенту

Функция: domain.setfilter

Уровень доступа: admin

Имя файла

Функция: domain.doc

Результат: список элементов

Документы

Уровень доступа: admin user

ПараметрЗначение
idId
profile Контакт домена
doctype Тип документа
name Имя файла
size Размер
props Свойства

Тип документа

Функция: domain.doc.edit

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
doctype Тип загружаемого документа

Добавить документ

Функция: domain.doc.upload

Уровень доступа: admin user

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:

  • Параметры:
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • plid — уникальный идентификатор родительского списка (элемент id из функции domain).
    • elid — уникальный идентификатор (элемент id из функции domain.doc)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
doctypeТип загружаемого документа

Удалить документ

Функция: domain.doc.delete

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Просмотреть выбранный файл

Функция: domain.doc.file

Уровень доступа: admin user

Отправить файлы для подтверждения данных контакта домена

Функция: domain.doc.verify

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Выставить документу статус верификации

Функция: domain.doc.verified

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.doc.

Результат: успешное выполнение операции или сообщение об ошибке

Скачать документ

Функция: domain.doc.download

Уровень доступа: admin user

Войти в панель с правами пользователя

Функция: domain.su

Уровень доступа: admin

Перенести домен/домены от другого регистратора

Функция: domain.order.transfer

Уровень доступа: user

Редактирование услуги

Функция: domain.edit

Уровень доступа: admin user

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

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент id из функции domain)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент id из функции domain)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
processingmodule Модуль обработки
autoprolong Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
createdate Дата заказа услуги
opendateДата создания. Дата фактического начала действия услуги
expiredate Действует до. Срок действия услуги
scheduledclose Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Запланировано удаление по окончанию оплаченного периода
reboot Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
note Комментарий к услуге, виден только сотрудникам провайдера
noexpense Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов

Удалить выделенные услуги

Функция: domain.delete

Уровень доступа: admin user

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Запросить данные и состояние домена у регистратора

Функция: domain.sync

Уровень доступа: admin

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции domain.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра

Функция: domain.filter