История оказания услуг

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

lang: ru
login:123/NIC-REG/adm
password:QWERTY
subject-contract:3457/NIC-D
request:service
operation:search
request-id:20011220103455.12345@nic.ru

[service]
service:mforwarding
domain:TEST*.RU
state:1
re-registration-flag:0
period-start-date:01.10.2001
period-end-date:31.03.2002
services-objects-limit:10
services-objects-first:1

В заголовке запроса необходимо указать значения request:service и operation:search (см. описание формата заголовка запроса).

После заголовка запроса следует блок service, в котором следует задать данные для поиска. Поиск осуществляется с логикой "и" для перечисленных полей. Блок начинается заголовком, указанным в квадратных скобках в отдельной строке.

Блок [service] может состоять из следующих полей:

  • service
    Тип услуг, поиск которых производится (см. значения полей service и template). Необязательное поле (в случае отсутствия производится поиск услуг всех типов). Однострочное поле.
  • domain
    Имя домена, для которого производится поиск услуг. Поле может содержать латинские буквы, цифры, дефисы, точку и символ "звездочку" (*). Имя домена и зону следует указывать в верхнем регистре. "Звездочка" заменяет группу символов (ноль и более). Доменное имя на национальном языке должно быть указано в виде "XN--***". Необязательное поле. Однострочное поле.
  • state
    Признак услуги в отношении ее оплаты: 1 для оплаченных услуг, 0 для неоплаченных (продления услуг на очередной период, от которых можно отказаться) и 2 для аннулированных. Необязательное поле (по умолчанию ищутся все услуги). Однострочное поле.
  • re-registration-flag
    Признак услуги в отношении ее продления: 0 для услуг, заказанных впервые, и 1 для которых это не первый период действия. Необязательное поле (по умолчанию ищутся все услуги). Однострочное поле.
  • period-start-date
    Дата начала действия услуг в формате DD.MM.YYYY (цифры). В случае указания этой даты производится поиск услуг, действие которых начинается в указанную дату или позже. Необязательное поле. Однострочное поле.
  • period-end-date
    Дата завершения действия услуг в формате DD.MM.YYYY (цифры). В случае указания этой даты производится поиск услуг, действие которых заканчивается в указанную дату или раньше. Необязательное поле. Однострочное поле.
  • service-objects-limit
    Количество блоков с данными об услугах, выдаваемых в ответе. В случае, если вы печатаете результаты ответа на странице, то значение этого поля можно установить например в 10 - база данных будет выдавать по 10 услуг, и на странице вашего интерфейса будет отображаться по 10 строк. Поле может содержать число от 1 до 64000. Необязательное поле (по умолчанию его значение равно 10). Однострочное поле.
  • service-objects-first
    Порядковый номер блока с данными об услугах, начиная с которого (из числа найденных в базе данных) блоки будут выдаваться в ответе. Для постраничной выдачи услуг в вашем интерфейсе, если на каждой странице отображается по 10 услуг, для первой страницы это поле нужно устанавливать равным 1, для второй - 11, для третей - 21, и так далее. Поле может содержать число от 1 до 64000. Необязательное поле (по умолчанию его значение равно 1). Однострочное поле.

Порядок следования полей в запросе произвольный в пределах каждого блока. Многострочные поля записываются в несколько строк, при этом в начале каждой строки присутствует название поля и разделитель (двоеточие). Для однострочных полей повторение не допускается. Необязательные поля могут либо отсутствовать в блоке, либо их значение может быть пустым (состоящим из пробельных символов).

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

State: 200 OK
request-id:20011220103455.12345@nic.ru

[services-list]
services-found:6
services-limit:10
services-first:1

[service]
subject-contract:12345/NIC-D
service:domain_ru
service-id:294986
period-start-date:08.11.2001
realization-date:08.11.2002
sum:20y.e.
prolong-flag:1
domain:AOISDUFYRT.RU
descr:Domain for testing purpose
nameservers:ns3.nic.ru
nameservers:ns4.nic.ru
testing-nameservers:ns3.nic.ru
testing-nameservers:ns4.nic.ru

[service]
subject-contract:12345/NIC-D
service:primary_var
service-id:294985
period-start-date:08.11.2001
realization-date:08.11.2002
sum:20y.e.
prolong-flag:1
domain:TEST.RU
nserver:ns3.nic.ru 194.85.61.20
nserver:ns4.nic.ru 194.226.96.8
secondary:194.226.96.8

[service]
subject-contract:12345/NIC-D
service:primary_fixed
service-id:294947
period-start-date:08.11.2001
realization-date:08.11.2002
sum:5y.e.
prolong-flag:0
domain:DEEP.SUB.TEST.RU
nserver:ns.DEEP.TEST.RU 1.3.4.5, 2.4.5.6
nserver:ns6.DEEP.TEST.RU 3.4.5.7
nserver:ns5.nic.ru
secondary:194.226.96.8

[service]
subject-contract:12345/NIC-D
service:secondary
service-id:293476
period-start-date:08.11.2001
realization-date:08.11.2002
sum:5y.e.
prolong-flag:1
domain:TEST.RU
primary-ip:194.85.61.20

[service]
subject-contract:12345/NIC-D
service:wforwarding
service-id:294962
period-start-date:08.11.2001
realization-date:08.11.2002
sum:5y.e.
prolong-flag:0
domain:1353.RU
url:http://info.nic.ru/
frames:ON

[service]
subject-contract:12345/NIC-D
service: new_wf
service-id:294962
period-start-date:19.10.2010
realization-date: 19.10.2011
sum:5y.e.
prolong-flag:0
domain:1353.RU
wf0: https://www.nic.ru:12349 www / 302 NO
wf1: https://www.nic.ru / Page Title YES

[service]
subject-contract:12345/NIC-D
service:mforwarding
service-id:295032
period-start-date:08.11.2001
realization-date:08.11.2002
sum:20y.e.
prolong-flag:1
domain:AHA.RU
forward-to:* *@test.ru

Ответ содержит заголовок (см. формат заголовка ответа) и тело ответа, которое отделяется от заголовка пустой строкой.

В случае успешного выполнения запроса (код 200) в теле ответа содержится блок services-list, содержащий служебную информацию о результатах поиска, а также блоки service c данными по найденным услугам.

Блок [services-list] содержит следующие поля:

  • services-found
    Количество услуг, найденных по запросу в базе данных.
  • services-limit
    Количество услуг, выданных по запросу. Соответствует затребованному количеству выдаваемых услуг.
  • services-first
    Порядковый номер услуги, начиная с которой (из числа найденных в базе данных) осуществляется выдача. Соответствует затребованному порядковому номеру начальной услуги.

В блоках [service-object] содержатся следующие поля, общие для всех услуг:

  • subject-contract
    Номер анкеты клиента, для которого была заказана услуга.
  • service
    Тип услуги (см. значения полей service и template).
  • service-id
    Внутренний идентификатор услуги в базе данных. Служебное поле.
  • period-start-till
    Дата начала действия услуги в формате DD.MM.YYYY.
  • realization-date
    Дата окончания действия услуги в формате DD.MM.YYYY. Обычно совпадает с датой, по которую оплачена услуга, кроме случаев, когда дополнительная услуга для домена заказываются отдельно после регистрации домена. В этом случае датой окончания действия дополнительной услуги будет дата окончания делегирования домена, если не заказана услуга продления регистрации домена на очередной период.
  • sum
    Стоимость услуги с указанием валюты, в которой она исчисляется.
  • prolong-flag
    Флаг продления услуги: 1, если услуга помечена для продления на следующий учетный период и 0 в противном случае. Изначально этот флаг устанавливается в 1 для всех услуг, его значение можно изменить через заказ на продление услуг.
  • domain
    Название домена, для которого оказывается услуга.

Кроме того, для каждого типа услуг в блоках [service-object] могут присутствовать дополнительные поля, содержащие специфичные для этой услуги данные.

Дополнительные поля для услуги регистрации и продления регистрации доменов:

  • descr
    Описание домена в свободной текстовой форме, выдаваемое через Whois-сервис.
  • nameservers
    DNS-серверы домена в формате имя_сервера - пробел - IP-адреса через запятую.
  • testing-nameservers
    В том случае, если DNS-серверы домена были изменены и в данный момент производится их тестирование, в этом поле отображаются новые DNS-серверы, в то время как в поле nameservers - старые. В остальных случаях это поле не выводится.

Дополнительные поля для услуги Primary-Standard:

  • nserver
    DNS-серверы домена, для которого оказывается услуга, в формате имя_сервера - пробел - IP-адреса через запятую.
  • secondary
    IP-адреса secondary DNS-серверов (через запятую), для которых обеспечивается возможность скачивания зоны.

Дополнительные поля для услуги Primary-Auto:

  • nserver
    DNS-серверы домена, для которого оказывается услуга, в формате имя_сервера - пробел - IP-адреса через запятую.
  • secondary
    IP-адреса secondary DNS-серверов (через запятую), для которых обеспечивается возможность скачивания зоны.

Дополнительные поля для услуги Web-forwarding:

  • url
    URL, на который осуществляется перенаправление HTTP-запроса.
  • frames
    ON в случае, если перенаправление запроса осуществляется с помощью структуры фреймов, или OFF в случае, если перенаправление осуществляется через HTTP Redirect (см. описание услуги Web-forwarding).

Дополнительное поле для услуги Перенаправление домена:

Дополнительное поле для услуги Перенаправление почты:

  • forward-to
    Шаблон управления почтой: звездочка (т.е. перенаправлять всю почту), пробел, далее адрес e-mail для перенаправления почты, в случае, если перенаправление осуществляется на один адрес, или конструкция *@домен, если перенаправление осуществляется на аналогичные адреса другого домена (см. Описание услуги Перенаправление почты).

Всё ещё остались вопросы?