Домены

Список команд доменного API

Наш API - это ваш продвинутый набор инструментов для управления доменами и их приобретения, созданный для эффективности. С более чем 50 командами для настройки, управления, регистрации и ставок на платформе Dynadot у вас будет полный контроль над вашим аккаунтом и настройками домена в любом программном обеспечении API по вашему выбору. Наш доменный API доступен для всех аккаунтов, так что начните уже сегодня!

Начало работы с расширенным API для доменов

Запросы к нашему API продвинутого домена отправляются по следующему URL:

https://api.dynadot.com/api3.xml

Запросы должны быть отправлены через https (защищенный сокет) для обеспечения безопасности. Запрос должен содержать два параметра: 'Key' и 'Command'. Каждая команда может быть нажата, чтобы увидеть связанные с ней параметры.

Вы получите разные значения количества потоков в зависимости от уровня цен вашей учетной записи:

Уровень цен	Учетная запись
Обычный	1 поток
Оптовый	5 потоков
Супер оптовый	25 потоков
Премиум оптовый	25 потоков

Параметр запросаПояснение

Параметр запроса
Пояснение

KeyВаш ключ доступа к API доступен в панели управления вашей учетной записи Dynadot в боковом меню 'Инструменты' -> 'API'.

Command

Domain:

, , , , , ,

, , , , , , , , , , , , , , , , , , ,

, , , ,

,

contact:

, , , , , ,

, ,

Nameserver:

, , , , , , ,

Account:

, , , , , , , , , , , ,

Folder:

, , , , , , , , , , , , , ,

Aftermarket:

, ,

, , , ,

, , , , , , , ,

Other:

, , , , , ,

XML Запрещать (Prohibit)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Команда поиска search

Support multi-thread

При вызове команды search, должны быть включены следующие параметры:

Параметр поискового запросаПояснение

Параметр поискового запроса
Пояснение

domain0 - domain99Имя домена, которое вы ищете. Обычная учетная запись может указывать 1 домен для каждой команды, оптовая и супероптовая учетная запись может указывать до 100 доменов

language0 - language99 (необязательно)Метка языка для соответствующего домена, используется только для IDN

show_price (необязательно)Если вы хотите показать цену в валюте вашего аккаунта, установите значение «1».

currency (необязательно)Вы можете решить, в какой валюте отображать данные аукциона, этот параметр поддерживает значения «USD», «CNY», «GBP», «EUR», «INR», «CAD» и так далее. Если вы пропустили этот параметр, мы будем использовать валюту учетной записи по умолчанию

XML-тег результатаПояснение

XML-тег результата
Пояснение

<Results></Results>Корневой узел XML-запроса команды поиска

<SearchResponse></SearchResponse>Тег ответа поиска

<SearchHeader></SearchHeader>Тег заголовка поиска

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<DomainName></DomainName>Доменное имя, которое вы искали

<Available></Available>Доступно ли доменное имя

<Price></Price>Если вы установите для «show_price» значение «1», вам будет предоставлена информация о цене (если домен доступен).

<Language></Language>Информация о языке для доменного имени

Search Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD

Response (XML format)

<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Available>yes</Available>
      <Price>77.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Available>yes</Available>
      <Price>44.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
</Results>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD

Response (JSON format)

{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}

Команда регистрации register

Support multi-thread

Вызов команды register создаст и обработает заявку на регистрацию. У вас должно быть достаточно средств на счету учетной записи, чтобы оплатить заказ. При вызове команды register должны быть включены следующие параметры:

Параметр запроса на регистрациюПояснение

Параметр запроса на регистрацию
Пояснение

domainДоменное имя, которое вы хотите зарегистрировать, максимум 1 за запрос.

language (необязательно)Метка языка для запрашиваемого домена, нужна только для доменов IDN

durationНа какой срок зарегистрировать домен

registrant_contact (необязательно)Контакт регистратора, который вы хотите использовать в домене

admin_contact (необязательно)Контакт администратора, который вы хотите использовать на домене

technical_contact (необязательно)Технический контакт, который вы хотите использовать на домене

billing_contact (необязательно)Контакт по выставлению счетов, которого вы хотите использовать на домене

option0 (при необходимости)
Имя регистранта .AT, .BE,

option1 (при необходимости)Организация регистрации .AT, .BE, (необязательно)
Для .AT можно указать option0, option1, или и то, и другое

premium (необязательно)Если вы хотите зарегистрировать премиум-домен, установите его равным "2" (по желанию)

coupon (необязательно)Код купона, который вы хотите применить к этой команде.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<RegisterResponse></RegisterResponse>Тег ответа регистрации

<RegisterHeader></RegisterHeader>Тег заголовка регистрации

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<RegisterContent></RegisterContent>Тег содержимого регистрации

<Expiration></Expiration>Дата истечения в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года), используется только при результате "success"

<Registration></Registration>Дата регистрации в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года), используется только при результате "success"

Пример регистрации

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD

Response (JSON format)

{
  "RegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.net",
    "Expiration": 1458379145266
  }
}

Команда удаления delete

Support multi-thread

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

Параметр запроса на удалениеПояснение

Параметр запроса на удаление
Пояснение

domainДоменное имя, которое вы хотите удалить, количество доменов, которое можно удалить за один запрос: 1

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DeleteResponse></DeleteResponse>Тег ответа удаления

<DeleteHeader></DeleteHeader>Тег заголовка удаления

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com

Response (JSON format)

{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}

Команда продления renew

Support multi-thread

Вызов команды renew создает и выполняет заказ на продление. На счету учетной записи должно быть достаточно средств для оплаты заказа. При вызове команды renew необходимо указать следующие параметры:

Параметр запроса на продлениеПояснение

Параметр запроса на продление
Пояснение

domainДомен, который вы хотите продлить, только 1 домен может быть продлен за один запрос

durationНа сколько лет вы хотите продлить домен

year (необязательно)Текущий год окончания регистрации домена

price_check (необязательно)Вы можете добавить данный параметр в команду, чтобы проверить информацию о цене на продление этого домена. ПРИМЕЧАНИЕ. Если вы добавите этот параметр в команду, наш API не будет обновлять домен, а только отобразит информацию о цене.

coupon (необязательно)Код купона, который вы хотите применить к этой команде.

no_renew_if_late_renew_fee_needed (необязательно)Вы можете добавить этот параметр к команде, чтобы избежать продления, если для домена требуется плата за продление после срока действия. Если для продления домена требуется плата за продление после срока действия, а в команде передан параметр «no_renew_if_late_renew_fee_needed = 1», домен не будет продлен.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<RenewResponse></RenewResponse>Тег ответа продления, это корневой узел XML-документа ответа

<RenewHeader></RenewHeader>Заголовок продления

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<PriceInfo></PriceInfo>Тег информации о цене, используется только при статусе "price_check_success"

<RenewContent></RenewContent>Тег содержимого продления, используется только при статусе "success"

Renew Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Response (XML format)

<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Response (JSON format)

{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}

Команда на отправку

Support multi-thread

Вызов команды push создаст и обработает заказ на передачу домена. Вы должны разблокировать свой домен и учетную запись для заказа. Аккаунт получателя должен отклонить/принять домен для выполнения заказа. При вызове команды push должны быть включены следующие параметры:

Параметр запроса на передачуПояснение

Параметр запроса на передачу
Пояснение

domainДоменное имя, которое вы хотите передать. Мы также поддерживаем массовую передачу (push), вы можете использовать ";" для разделения доменов. Пример: domain1.com;domain2.com

receiver_push_usernameВведите имя пользователя аккаунта получателя

unlock_domain_for_push(optional)Установите для этого параметра значение «1». Если домен заблокирован, мы автоматически разблокируем его, поэтому вам не нужно вручную разблокировать его

receiver_email(optional)Отправить письмо на электронный адрес получателя.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<PushResponse></PushResponse>Тег ответа операции push, это корневой узел XML-документа ответа

<PushHeader></PushHeader>Заголовок передачи

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Push Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Response (XML format)

<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Response (JSON format)

{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}

Перенос Команды

Support multi-thread

Вызов команды переноса создает и выполняет заказ на перенос. Некоторые TLD могут потребовать от отдающего регистратора подтверждения для выполнения заказа. При вызове команды переноса, необходимо указать следующие параметры:

Параметр запроса на переносПояснение

Параметр запроса на перенос
Пояснение

domainДоменное имя, которое вы хотите перенести в Dynadot, за запрос может быть перенесен только 1 домен

authКод авторизации для запроса на перенос.

registrant_contact (необязательно)Контакт зарегистрированного лица, который вы хотите использовать после завершения трансфера. (Не все TLD поддерживают эту функцию)

admin_contact (необязательно)Контакт администратора, которого вы хотите использовать после завершения трансфера. (Не все TLD поддерживают эту функцию)

technical_contact (необязательно)Технический контакт, которого вы хотите использовать после завершения переноса. (Не все TLD поддерживают эту функцию)

billing_contact (необязательно)Контакт для выставления счетов, которого вы хотите использовать после завершения перевода. (Не все TLD поддерживают эту функцию)

premium (необязательно)Если вы хотите передать премиум-домен, установите его равным "1" (необязательно)

privacy (необязательно)Статус конфиденциальности домена, который вы хотите установить, может быть "on" или "off". . Уровень конфиденциальности по умолчанию для аккаунта будет применен, если введены неверные данные или не будет введено ничего.

name_servers (необязательно)Список серверов имен, которые будут применены к домену после завершения передачи. Вы можете использовать ",", чтобы разделить серверы имен. Пример: ns1.domain1.com,ns2.domain2.com

coupon (необязательно)Код купона, который вы хотите применить к этой команде.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<TransferResponse></TransferResponse>Тег ответа операции переноса, это корневой узел XML-документа ответа

<TransferHeader></TransferHeader>Заголовок переноса

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

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

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
    <DomainName>domain1.com</DomainName>
    <OrderId>1234567</OrderId>
  </TransferHeader>
</TransferResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Response (JSON format)

{
  "TransferResponse": {
    "ResponseCode": 0,
    "Status": "order created",
    "DomainName": "domain1.com",
    "OrderId": "1234567"
  }
}

Команда регистрации в больших количествах

Support multi-thread

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

Параметр запроса массовой регистрацииПояснение

Параметр запроса массовой регистрации
Пояснение

domain0-domain99Доменное имя (имена), которые вы хотите зарегистрировать, максимум 100 доменов может быть зарегистрировано за запрос

premium (необязательно)Если вы хотите зарегистрировать премиум-домен, установите его равным "2" (по желанию)

currency (необязательно)Вы можете выбрать тип валюты, поддерживаемые параметры - «USD», «CNY», «GBP», «EUR», «INR», «CAD» и т.д. Если вы пропустили этот параметр, мы используем валюту по умолчанию для вашей учетной записи.

coupon (необязательно)Код купона, который вы хотите применить к этой команде.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<BulkRegisterResponse></BulkRegisterResponse>Тег ответа регистрации в большом объеме

<BulkRegisterHeader></BulkRegisterHeader>Метка заголовка массовой регистрации

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<BulkRegisterContent></BulkRegisterContent>Метка массовой регистрации контента

<Result></Result>Результат регистрационных действий

<Message></Message>Сообщение об ошибке действия регистрации, используется только при результате "error"

Пример массовой регистрации

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
  <BulkRegisterHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BulkRegisterHeader>
  <BulkRegisterContent>
    <BulkRegister>
      <RegisterResult>
        <DomainName>domain0.com</DomainName>
        <Expiration>1234567890</Expiration>
        <Result>success</Result>
        <Message>-</Message>
      </RegisterResult>
      <RegisterResult>
        <DomainName>domain1.com</DomainName>
        <Expiration>-</Expiration>
        <Result>error</Result>
        <Message>not_available</Message>
      </RegisterResult>
    </BulkRegister>
  </BulkRegisterContent>
</BulkRegisterResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD

Response (JSON format)

{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}

Команда получения информации о домене

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Параметр запроса информации о доменеПояснение

Параметр запроса информации о домене
Пояснение

domainТолько 1 домен разрешен за запрос

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DomainInfoResponse></DomainInfoResponse>Корневой узел XML-документа ответа

<DomainInfoResponseHeader></DomainInfoResponseHeader>Заголовок ответа

<ResponseCode></ResponseCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<DomainInfoContent></DomainInfoContent>Содержимое ответа

<Domain></Domain>Домен

<Name></Name>Доменное имя

<Expiration></Expiration>Дата истечения регистрации домена в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

<Registration></Registration>Дата регистрации домена по времени Unix (миллисекунды с полуночи по UTC января 1, 1970)

<NameServerSettings></NameServerSettings>Настройки сервера доменного имени

<Type></Type>Тип сервера доменного имени

<WithAds></WithAds>Если вам нужна парковочная страница для домена

<Whois></Whois>Информация Whois

<Registrant></Registrant>Информация о регистраторе

<ContactId></ContactId>Идентификатор контакта

<Admin></Admin>Информация об администраторе

<Technical></Technical>Техническая информация

<Billing></Billing>Информация о счетах (биллинг)

<Locked></Locked>Заблокирован или нет

<Disabled></Disabled>Статус "включено/выключено"

<UdrpLocked></UdrpLocked>Установлена ли блокировка UDRP

<RegistrantUnverified></RegistrantUnverified>Непроверенное регистрирующее лицо

<Hold></Hold>Удержание

<Privacy></Privacy>Статус скрытия личных данных

<isForSale></isForSale>Статус "для продажи"

<RenewOption></RenewOption>Настройка продления

<Note></Note>Заметки

<Folder></Folder>Информация о папке

<FolderId></FolderId>Идентификатор папки

<FolderName></FolderName>Название папки

Domain Information Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
  <DomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </DomainInfoHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1361430589062</Expiration>
      <Registration>1234567890123</Registration>
      <NameServerSettings>
        <Type>Dynadot Parking</Type>
        <WithAds>Yes</WithAds>
      </NameServerSettings>
      <Whois>
        <Registrant>
          <ContactId>0</ContactId>
        </Registrant>
        <Admin>
          <ContactId>0</ContactId>
        </Admin>
        <Technical>
          <ContactId>0</ContactId>
        </Technical>
        <Billing>
          <ContactId>0</ContactId>
        </Billing>
      </Whois>
      <Locked>yes</Locked>
      <Disabled>no</Disabled>
      <UdrpLocked>no</UdrpLocked>
      <RegistrantUnverified>no</RegistrantUnverified>
      <Hold>no</Hold>
      <Privacy>none</Privacy>
      <isForSale>yes</isForSale>
      <RenewOption>no renew option</RenewOption>
      <Note/>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com

Response (JSON format)

{
  "DomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainInfo": {
      "Name": "domain1.com",
      "Expiration": "1361430589062",
      "Registration": "1234567890123",
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      },
      "Whois": {
        "Registrant": {
          "ContactId": "0"
        },
        "Admin": {
          "ContactId": "0"
        },
        "Technical": {
          "ContactId": "0"
        },
        "Billing": {
          "ContactId": "0"
        }
      },
      "Locked": "yes",
      "Disabled": "no",
      "UdrpLocked": "no",
      "RegistrantUnverified": "no",
      "Hold": "no",
      "Privacy": "none",
      "isForSale": "yes",
      "RenewOption": "no renew option",
      "Note": "",
      "Folder": {
        "FolderId": "-1",
        "FolderName": "(no folder)"
      }
    }
  }
}

Команда установки данных Whois

Support multi-thread

При вызове команды установки данных Whois должны быть указаны следующие параметры:

Параметр запроса установки данных WhoisПояснение

Параметр запроса установки данных Whois
Пояснение

domainДоменное имя, которое вы хотите изменить, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми

registrant_contactИнформация регистрирующего лица

admin_contactИнформация об администраторе домена

technical_contactТехническая информация о домене

billing_contactБиллинговая информация домена

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetWhoisResponse></SetWhoisResponse>Корневой узел XML-документа ответа

<SetWhoisHeader></SetWhoisHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Whois Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (XML format)

<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (JSON format)

{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки серверов имен

Support multi-thread

При вызове команды установки серверов имен должны быть указаны следующие параметры:

Параметр запроса установки серверов именПояснение

Параметр запроса установки серверов имен
Пояснение

ns0 - ns12Сервера имен, которые вы хотите установить для домена. Максимальное количество серверов имен, которое можно указать: 13, но они должны быть предварительно внесены в вашу учетную запись.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetNsResponse></SetNsResponse>Тег ответа установленного сервера имен, это корневой узел XML-документа ответа

<SetNsHeader></SetNsHeader>Тег заголовка ответа установленного сервера имен

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки Ns

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Response (JSON format)

{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда установки парковки

Support multi-thread

При вызове команды установки парковки должны быть указаны следующие параметры:

Параметр запроса установки парковкиПояснение

Параметр запроса установки парковки
Пояснение

with_ads (необязательно)Если вы не хотите рекламы от сторонних поставщиков, укажите в этом параметре "no"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetParkingResponse></SetParkingResponse>Тег ответа установки парковки, это корневой узел XML-документа ответа

<SetParkingHeader></SetParkingHeader>Тег заголовка ответа установки парковки

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Parking Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no

Response (XML format)

<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no

Response (JSON format)

{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки перенаправления

Support multi-thread

При вызове команды установки перенаправления должны быть указаны следующие параметры:

Параметр запроса установки перенаправленияПояснение

Параметр запроса установки перенаправления
Пояснение

forward_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.

is_temp (необязательно)Статус перенаправления для домена, по умолчанию (временный) "temporary", если вы хотите установить постоянное перенаправление, укажите в этом параметре "no"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetForwardingResponse></SetForwardingResponse>Корневой узел XML-документа ответа

<SetForwardingHeader></SetForwardingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Forwarding Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com

Response (XML format)

<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com

Response (JSON format)

{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Установка скрытого перенаправления (stealth)

Support multi-thread

При вызове команды установки скрытого перенаправления должны быть указаны следующие параметры:

Параметр запроса установки скрытого перенаправленияПояснение

Параметр запроса установки скрытого перенаправления
Пояснение

stealth_urlURL-адрес, на который вы хотите перенаправить ваш домен. Обратите внимание, что параметр должен быть закодирован, чтобы вызов API интерпретировался правильно.

stealth_title (необязательно)Заголовок страницы

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetStealthResponse></SetStealthResponse>Корневой узел XML-документа ответа

<SetStealthHeader></SetStealthHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Stealth Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com

Response (XML format)

<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com

Response (JSON format)

{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки хостинга

Support multi-thread

При вызове команды установки хостинга должны быть указаны следующие параметры:

Параметр запроса установки хостингаПояснение

Параметр запроса установки хостинга
Пояснение

hosting_typeТип желаемого хостинга, можно выбрать "advanced" или "basic"

mobile_view_onЕсли в hosting_type выбрано "advanced",, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetHostingResponse></SetHostingResponse>Корневой узел XML-документа ответа

<SetHostingHeader></SetHostingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Hosting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes

Response (XML format)

<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes

Response (JSON format)

{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда Set DNS2

Support multi-thread

При вызове команды set DNS2 необходимо указать следующие параметры:

Пожалуйста, обратите внимание, что выполнение команды SET_DNS2 по умолчанию перезапишет текущие настройки DNS. Чтобы изменить это поведение и добавить новые настройки DNS, вы можете использовать необязательный параметр add_dns_to_current_setting.

Параметры запроса Set DNS2Пояснение

Параметры запроса Set DNS2
Пояснение

main_record_type0 - main_record_type19 (optional)Тип основной записи должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»

main_record0 - main_record19Укажите запись DNS для вашего домена

main_recordx0 - main_recordx19Приоритет MX, тип переадресации («1» для 301, «2» для 302), заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record_type типа «forward», «mx», «stealth», «email».

subdomain0 - subdomain99 (необязательно)Subdomain records (необязательно)

sub_record_type0 - sub_record_type99Тип записи поддомена должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»

sub_record0 - sub_record99IP-адрес или узел назначения поддомена

sub_recordx0 - sub_recordx99Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record_type типа «forward», «mx», «stealth», «email»

ttl (необязательно)Время жизни (time to live)

add_dns_to_current_setting (необязательно)Если вы хотите добавить новые настройки DNS к существующим настройкам DNS. Установите его равным «1» (необязательно)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDnsResponse></SetDnsResponse>Корневой узел XML-документа ответа

<SetDnsHeader></SetDnsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set DNS2 Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1

Response (JSON format)

{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда установки DNSSEC

Support multi-thread

Вызов команды Set Dnssec установит доменный dnssec. Эта команда доступна только в форматах XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Вы можете выбрать заполнение соответствующих значений параметров в Опции на основе своего доменного имени.

Вариант 1 : domain_name , key_tag , digest_type , digest , algorithm

Опция 2 : domain_name , flags , public_key , algorithm

Примечания: Пожалуйста, выберите наиболее подходящий номер для вашего параметра, соответствующий соответствующей метке.

Установить параметр запроса DnssecПояснение

Установить параметр запроса Dnssec
Пояснение

domain_nameДоменное имя, для которого нужно настроить dnssec

key_tagБрелок

digest_typeВы можете выбрать номер из следующего списка для представления вашего типа цифровой подписи: SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)

digestПожалуйста, введите значение, соответствующее выбранному вами типу дайджеста

algorithmВы можете выбрать номер из следующего списка для представления вашего алгоритма цифровой подписи: RSA/MD5(1) Diffie-Hellman (2) DSA/SHA-1(3) Elliptic Curve (4) RSA/SHA-1(5) DSA-NSEC3-SHA1(6) RSASHA1-NSEC3-SHA1(7) RSA/SHA-256(8) RSA/SHA-512(10) GOSTR 34.10-2001(12) ECDSA Curve P-256 with SHA-256(13) ECDSA Curve P-384 with SHA-384(14) ED25519(15) ED448(16) Indirect (252) Private DNS (253) Private OID (254)

flagsВы можете выбрать число из следующего списка, чтобы представить свой символ цифровой подписи: ZSK (256) KSK (257)

public_keyОткрытый ключ должен быть в кодировке base64.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDnssecResponse></SetDnssecResponse>Корневой узел ответа

<SetDnssecHeader></SetDnssecHeader>Установить заголовок Dnssec

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

Настройка DNSSEC Пример

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetDnssecResponse>
  <SetDnssecHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnssecHeader>
  <SetDnssecContent/>
</SetDnssecResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1

Response (JSON format)

{
  "SetDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда установки перенаправления Email

Support multi-thread

При вызове команды установки перенаправления Email должны быть указаны следующие параметры:

Параметр запроса установки перенаправления EmailПояснение

Параметр запроса установки перенаправления Email
Пояснение

forward_typeТип перенаправления, варианты: "donot": не перенаправлять, "mx": направлять электронную почту на другой почтовый узел (запись MX), "forward": направлять электронную почту на другой почтовый узел

username0 - username9Имя пользователя, используется только, если в "forward_type" указано "forward"

exist_email0 - exist_email9Существующий адрес электронной почты, используется только, когда в "forward_type" указано "forward"

mx_host0 - mx_host2Почтовый узел, используется только, когда в "forward_type" указано "mx"

mx_distance0 - mx_distance2Distance0 — высший приоритет, используется только, когда в "forward_type" указано "mx"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetEmailForwardingResponse></SetEmailForwardingResponse>Корневой узел XML-документа ответа

<SetEmailForwardingHeader></SetEmailForwardingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Email Forward Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]

Response (XML format)

<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]

Response (JSON format)

{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда сброса параметра для домена

Support multi-thread

При вызове команды сброса значения для домена должны быть указаны следующие параметры:

Параметр запроса сброса значения для доменаПояснение

Параметр запроса сброса значения для домена
Пояснение

serviceСервис, который вы хотите очистить, может быть "forward", "stealth", "email_forwarding", "dns", "dnssec", и "nameservers"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Корневой узел XML-документа ответа

<SetClearDomainSettingHeader></SetClearDomainSettingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Clear Domain Setting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers

Response (XML format)

<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers

Response (JSON format)

{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки папки

Support multi-thread

При вызове команды установки папки должны быть указаны следующие параметры:

Параметр запроса установки папкиПояснение

Параметр запроса установки папки
Пояснение

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

folderНазвание папки, в которую вы хотите переместить ваш домен. Укажите "Default" в качестве названия папки, если хотите переместить домен в папку по умолчанию. Название папки чувствительно к регистру. Например "Folder1" и "folder1" — две разных папки.

folder_id (необязательно)Идентификатор папки, в которую вы хотите переместить ваш домен

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderResponse></SetFolderResponse>Тег ответа операции установки папки, это корневой узел XML-документа ответа

<SetFolderHeader></SetFolderHeader>Заголовок установки бесплатного хостинга

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1

Response (XML format)

<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1

Response (JSON format)

{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки заметки

Support multi-thread

При вызове команды установки заметки должны быть указаны следующие параметры:

Параметр запроса установки заметкиПояснение

Параметр запроса установки заметки
Пояснение

domainДомен, для которого вы хотите установить заметку, только 1 домен может быть установлен за один запрос

noteЗаметка, которую вы хотите установить для домена, может иметь значение null

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetNoteResponse></SetNoteResponse>Корневой узел XML-документа ответа

<SetNoteHeader></SetNoteHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Note Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information

Response (XML format)

<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information

Response (JSON format)

{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки идентификатора клиента (ТОЛЬКО ДЛЯ ПРОДАВЦОВ)

Support multi-thread

Если вызывается команда установки идентификатора клиента, должны быть включены следующие параметры:

Установить параметр запроса ID клиентаПояснение

Установить параметр запроса ID клиента
Пояснение

domainДомен, который вы хотите установить , , несколько доменов разделяются запятыми ( Макс :100 )

customer_idИдентификатор клиента, который вы хотите установить для домена, не может быть пустым

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetCustomerIdResponse></SetCustomerIdResponse>Корневой узел XML-документа ответа

<SetCustomerIdHeader></SetCustomerIdHeader>Заголовок ответа

<SetCustomerIdContent></SetCustomerIdContent>Содержимое ответа

<SetCustomerIdSuccess></SetCustomerIdSuccess>Установка успешного содержания ответа с идентификатором клиента установлена

<SetCustomerIdFailed></SetCustomerIdFailed>Не удалось установить идентификатор клиента в содержимом ответа

<ResponseCode></ResponseCode>Если операция успешна, "0" для успеха, "-1" для неудачи, "1" для проблемы

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример идентификации клиента

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetCustomerIdResponse>
  <SetCustomerIdHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetCustomerIdHeader>
  <SetCustomerIdContent>
    <SetCustomerIdSuccess>
      <content>
        <Domain>domain1.com</Domain>
        <CustomerId>123456</CustomerId>
      </content>
      <content>
        <Domain>domain2.com</Domain>
        <CustomerId>123456</CustomerId>
      </content>
    </SetCustomerIdSuccess>
  </SetCustomerIdContent>
</SetCustomerIdResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Response (JSON format)

{
  "SetCustomerIdResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetCustomerIdSuccess": [
      {
        "Domain": "domain1.com",
        "CustomerId": 123456
      },
      {
        "Domain": "domain2.com",
        "CustomerId": 123456
      }
    ]
  }
}

Установка параметра продления

Support multi-thread

При вызове команды установки продления должны быть указаны следующие параметры:

Параметр запроса установки продленияПояснение

Параметр запроса установки продления
Пояснение

renew_optionМожет быть указано "donot", "auto", "reset"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetRenewOptionResponse></SetRenewOptionResponse>Корневой узел XML-документа ответа

<SetRenewOptionHeader></SetRenewOptionHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки продления

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto

Response (JSON format)

{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда установки скрытия данных

Support multi-thread

При вызове команды установки скрытия данных должны быть указаны следующие параметры:

Параметр запроса установки скрытия данныхПояснение

Параметр запроса установки скрытия данных
Пояснение

optionСтатус скрытия данных, который вы хотите установить для домена, может быть "full", "partial", или "off"

whois_privacy_optionСтатус конфиденциальности whois для домена, который вы хотите установить, может быть "yes" или "no".

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetPrivacyResponse></SetPrivacyResponse>Корневой узел XML-документа ответа

<SetPrivacyHeader></SetPrivacyHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Privacy Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off

Response (XML format)

<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off

Response (JSON format)

{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Цены на TLD

Support multi-thread

Эта функция доступна только в форматах XML и JSON:

Параметр запроса цен TldПояснение

Параметр запроса цен Tld
Пояснение

currency (необязательно)Валюта возвращаемого результата, должна быть "usd", "eur", или "cny", валюта по умолчанию - это валюта по умолчанию для Api в настройках учетной записи.

count_per_page (optional)Сколько сущностей отображается на странице

page_index (optional)Какие объекты страницы вы хотите просмотреть?

sort (optional)Пожалуйста, выберите один из следующих вариантов в качестве значения для параметра сортировки:
* Если вы его не выбрали, мы будем использовать сортировку по умолчанию.
1) RankAsc (По умолчанию)
2) RankDesc
3) NameAsc
4) NameDesc
5) SalesAsc
6) SalesDesc
7) LaunchDateAsc
8) LaunchDateDesc
9) CountAsc
10) CountDesc
11) RegistryAsc
12) RegistryDesc

XML-тег результатаПояснение

XML-тег результата
Пояснение

<TldPriceResponse></TldPriceResponse>Корневой узел XML-документа ответа

<TldPriceResponseHeader></TldPriceResponseHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<TldPriceContent></TldPriceContent>Содержимое ответа

<TldContent></TldContent>Информация о Tld

<Tld></Tld>Домены верхнего уровня

<Usage></Usage>Использование tld

<Price></Price>Информация о стоимости данного TLD. Содержит подтеги: : Единица измерения цены : Стоимость регистрации : Стоимость продления : Стоимость переноса.

<Privacy></Privacy>Если этот TLD поддерживает конфиденциальность whois

<GracePeriod></GracePeriod>Информация о периоде льготного использования этого TLD. Содержит подтеги: : Единица информации о периоде льготного использования : Период льготного использования для продления : Период льготного использования для удаления

<IDN></IDN>Если этот tld поддерживает интернационализированные доменные имена

<Restrictions></Restrictions>Доменное имя

TLD Prices Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
  <TldPriceResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <PriceLevel>Regular Pricing</PriceLevel>
    <Currency>USD</Currency>
  </TldPriceResponseHeader>
  <TldPriceContent>
    <TldContent>
      <Tld>com</Tld>
      <Usage>General</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>15.00</Register>
        <Renew>15.00</Renew>
        <Transfer>15.00</Transfer>
        <Restore>10.00</Restore>
      </Price>
      <Privacy>10.00</Privacy>
      <GracePeriod>
        <Unit>10.00</Unit>
        <Renew>10.00</Renew>
        <Delete>30</Delete>
        <Restore>YES</Restore>
      </GracePeriod>
      <IDN>YES</IDN>
      <Restrictions>--</Restrictions>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD

Response (JSON format)

{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": "com",
        "Usage": "General",
        "IDN": "YES",
        "Restrictions": "--",
        "Privacy": "10.00",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "15.00",
          "Renew": "15.00",
          "Transfer": "15.00",
          "Restore": "10.00"
        },
        "GracePeriod": {
          "Unit": "10.00",
          "Renew": "10.00",
          "Delete": "30",
          "Restore": "YES"
        }
      }
    ]
  }
}

Команда списка доменов

Support multi-thread

Эта функция доступна только в форматах XML и JSON:

Параметр запроса списка доменовПояснение

Параметр запроса списка доменов
Пояснение

customer_id (необязательно)Фильтрация данных по идентификатору клиента ( только реселлеры могут использовать этот параметр )

count_per_page (optional)Сколько сущностей отображается на странице

page_index (optional)Какие объекты страницы вы хотите просмотреть?

sort (optional)Пожалуйста, выберите один из следующих вариантов в качестве значения параметра сортировки:
* Если вы не выбрали его, мы используем сортировку по умолчанию.
1) CountAsc (По умолчанию)
2) CountDesc
3) NameAsc
4) NameDesc

XML-тег результатаПояснение

XML-тег результата
Пояснение

<ListDomainInfoResponse></ListDomainInfoResponse>Корневой узел XML-документа ответа

<ListDomainInfoHeader></ListDomainInfoHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<ListDomainInfoContent></ListDomainInfoContent>Содержимое ответа

<DomainInfoList></DomainInfoList>Список информации о доменах

<DomainInfo></DomainInfo>Информация о домене

<Domain></Domain>Домен

<Name></Name>Доменное имя

<Registration></Registration>Дата регистрации домена по времени Unix (миллисекунды с полуночи по UTC января 1, 1970)

<NameServerSettings></NameServerSettings>Значение сервера имен

<Type></Type>Тип значения сервера имен

<WithAds></WithAds>С рекламой или без нее

<Whois></Whois>Информация Whois

<Registrant></Registrant>Информация о регистраторе

<ContactId></ContactId>Идентификатор контакта

<Admin></Admin>Информация об администраторе

<Technical></Technical>Техническая информация

<Billing></Billing>Информация о счетах (биллинг)

<Locked></Locked>Заблокирован или нет

<Disabled></Disabled>Статус "включено/выключено"

<Hold></Hold>Удержание

<Privacy></Privacy>Статус скрытия личных данных

<isForSale></isForSale>Статус "для продажи"

<RenewOption></RenewOption>Настройка продления

<Note></Note>Заметки

<Folder></Folder>Информация о папке

<FolderId></FolderId>Идентификатор папки

<FolderName></FolderName>Название папки

Пример получения списка доменов

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain

Response (JSON format)

{
  "ListDomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "MainDomains": [
      {
        "Name": "domain-exp140.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "0"
          },
          "Admin": {
            "ContactId": "0"
          },
          "Technical": {
            "ContactId": "0"
          },
          "Billing": {
            "ContactId": "0"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      },
      {
        "Name": "domain-exp141.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "1"
          },
          "Admin": {
            "ContactId": "2"
          },
          "Technical": {
            "ContactId": "3"
          },
          "Billing": {
            "ContactId": "4"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      }
    ]
  }
}

Команда блокировки домена

Support multi-thread

Если вызывается команда блокировки домена, необходимо включить следующие параметры:

Параметр запроса блокировки доменаПояснение

Параметр запроса блокировки домена
Пояснение

domainДоменное имя, которое вы хотите заблокировать, только один домен 1 может быть введен за запрос

XML-тег результатаПояснение

XML-тег результата
Пояснение

<LockDomainResponse></LockDomainResponse>Корневой узел XML-документа ответа

<LockDomainHeader></LockDomainHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Lock Domain Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com

Response (XML format)

<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com

Response (JSON format)

{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Отменить команду передачи

Support multi-thread

Команда позволяет отменить элемент передачи в заказе. Если вызывается команда отмены передачи, должны быть включены следующие параметры:

Параметр отмены запроса на переводПояснение

Параметр отмены запроса на перевод
Пояснение

domainИмя домена, который вы хотите отменить передачу, можно вводить только один домен 1 за запрос

order_idИдентификатор заказа на перевод можно получить из другого API get_transfer_status.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<CancelTransferResponse></CancelTransferResponse>Корневой узел XML-документа ответа

<CancelTransferHeader></CancelTransferHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример отмены передачи

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com

Response (JSON format)

{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда статуса передачи

Support multi-thread

При вызове команды получения статуса передачи следующие параметры должны быть включены:

Получить параметр запроса статуса передачиПояснение

Получить параметр запроса статуса передачи
Пояснение

domainИмя домена, для которого вы хотите получить статус переноса, можно вводить только один домен 1 на запрос

transfer_typeТип перевода, для которого вы хотите получить статус перевода (входящий или исходящий перевод)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetTransferStatusResponse></GetTransferStatusResponse>Корневой узел XML-документа ответа

<GetTransferStatusHeader></GetTransferStatusHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetTransferStatusContent></GetTransferStatusContent>Содержимое ответа

<TransferList></TransferList>Список передач

<Transfer></Transfer>Передача информации

<OrderId></OrderId>Идентификатор заказа

<TransferStatus></TransferStatus>Статус передачи домена. Если вы получили «нет» или «утверждено», вы можете отменить передачу. Если вы получили «ожидание», это означает, что передача уже началась. Если вы получили «требуется код авторизации», это означает, что код авторизации неверный, вы можете использовать другой API SET_TRANSFER_AUTH для повторной отправки кода авторизации. Есть также другие статусы, мы отправим вам электронное письмо или их необходимо проверить нашими инженерами.

Get Transfer Status Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
  <GetTransferStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetTransferStatusHeader>
  <GetTransferStatusContent>
    <TransferList>
      <Transfer>
        <OrderId>testorderid</OrderId>
        <TransferStatus>teststatus</TransferStatus>
      </Transfer>
      <Transfer>
        <OrderId>testorderid2</OrderId>
        <TransferStatus>teststatus2</TransferStatus>
      </Transfer>
    </TransferList>
  </GetTransferStatusContent>
</GetTransferStatusResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in

Response (JSON format)

{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}

Установить код авторизации передачи для команды заказа передачи

Support multi-thread

Команда, которая позволяет обновлять код авторизации для обработки заказов на перевод. Если вызывается команда установки кода авторизации для передачи, следующие параметры должны быть включены:

Установить параметр запроса кода авторизации передачиПояснение

Установить параметр запроса кода авторизации передачи
Пояснение

domainДля имени домена, для которого вы обновляете авторизацию передачи, можно ввести только один домен 1 на запрос

auth_codeКод авторизации, который вы хотите повторно отправить

order_idИдентификатор заказа на перевод можно получить из другого API get_transfer_status.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetTransferStatusResponse></GetTransferStatusResponse>Корневой узел XML-документа ответа

<GetTransferStatusHeader></GetTransferStatusHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Transfer Auth Code Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Response (XML format)

<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Response (JSON format)

{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Авторизовать команду передачи в другой регистратор.

Support multi-thread

Параметр запроса авторизованного переводаПояснение

Параметр запроса авторизованного перевода
Пояснение

domainДля авторизации передачи только 1 домен может быть введен на запрос

order_idИдентификатор заказа Dynadot домена, который вы хотите перевести в другой реестр

authorizeЧтобы разрешить перевод, установите значение «одобрить». Чтобы отказать в переводе, установите значение «отклонить».

XML-тег результатаПояснение

XML-тег результата
Пояснение

<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>Корневой узел XML-документа ответа

<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<Result></Result>Результат авторизованного перевода

Авторизовать передачу примера

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123

Response (JSON format)

{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}

Получить команду кода авторизации передачи

Support multi-thread

Вы должны разблокировать свой домен и учетную запись перед запросом кода авторизации.

Параметр запроса кода авторизации переносаПояснение

Параметр запроса кода авторизации переноса
Пояснение

domainДоменное имя, для которого вы хотите получить код авторизации переноса, в запросе можно указать только 1 домен

new_code (optional)Сгенерировать новый код авторизации переноса

unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Если вы хотите разблокировать домен для переноса, установите для этого параметра «1». В случае успешной обработки запроса домен будет разблокирован.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Корневой узел XML-документа ответа

<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<AuthCode></AuthCode>Код авторизации используется для запуска переноса домена.

Пример получения кода авторизации переноса

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Response (JSON format)

{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}

Команда запроса на передачу домена

Support multi-thread

Вызов команды Get Domain Push Request позволит получить запрос на проброс домена. Эта команда доступна только в форматах XML и JSON.

Получить параметр запроса на продвижение доменаПояснение

Получить параметр запроса на продвижение домена
Пояснение

N/AДополнительных параметров не требуется

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetDomainPushRequestResponse></GetDomainPushRequestResponse>Корневой узел ответа

<GetDomainPushRequestHeader></GetDomainPushRequestHeader>Получить заголовок запроса на проталкивание домена

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

<GetDomainPushRequestContent></GetDomainPushRequestContent>содержание ответа

<PushDomain></PushDomain>Передать домен

<PushDomainName></PushDomainName>Нажмите имя домена

Get Domain Push Request Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetDomainPushRequestResponse>
  <GetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDomainPushRequestHeader>
  <GetDomainPushRequestContent>
    <PushDomain>
      <PushDomainName>haha.com</PushDomainName>
    </PushDomain>
    <PushDomain>
      <PushDomainName>haha1.com</PushDomainName>
    </PushDomain>
  </GetDomainPushRequestContent>
</GetDomainPushRequestResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request

Response (JSON format)

{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}

Команда запроса на отправку доменного пуша

Support multi-thread

Вызов команды Set Domain Push Request установит запрос на передачу домена. Эта команда доступна только в форматах XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Установить параметр запроса передачи доменаПояснение

Установить параметр запроса передачи домена
Пояснение

domainsДоменное имя заказа для обработки

actionДействие заказа, который будет обрабатываться. Вы можете выбрать 'принять' или 'отклонить'.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDomainPushRequestResponse></SetDomainPushRequestResponse>Корневой узел ответа

<SetDomainPushRequestHeader></SetDomainPushRequestHeader>Установить заголовок запроса на передачу домена

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

Set Domain Push Request Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept

Response (JSON format)

{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Создать команду аудита CN

Support multi-thread

Команда позволяет создавать аудит CN для контакта. Если вызывается команда создания аудита cn, следующие параметры должны быть включены:

Создание параметра запроса аудита CNПояснение

Создание параметра запроса аудита CN
Пояснение

contact_idИдентификатор записи контакта, для которого вы хотите начать аудит, может быть введен только 1 идентификатор контакта за запрос.

contact_typeТип контакта, может быть "Физическое лицо" или "Юридическое лицо"

individual_id_typeТипы идентификации естественного лица, ожидаемые значения (описание значения):
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)

individual_license_idНомер лицензии удостоверения личности физического лица

individual_urlДокумент с идентификационным удостоверением лицензии на естественное лицо. URL-адрес файла на сервере. Разрешены только файлы jpg, gif, png, jpeg

enterprise_id_type (Mandatory when contact type is "Enterprise")Тип идентификатора предприятия, ожидаемые значения (описание значения) следующие:
ORG (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)

enterprise_license_id (Mandatory when contact type is "Enterprise")Номер лицензии документа предприятия

enterprise_url (Mandatory when contact type is "Enterprise")Документ о лицензии предприятия. Ссылка на файл на сервере. Разрешены только jpg, gif, png, jpeg

XML-тег результатаПояснение

XML-тег результата
Пояснение

<CreateCnAuditResponse></CreateCnAuditResponse>Корневой узел XML-документа ответа

<CreateCnAuditHeader></CreateCnAuditHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Создать пример аудита доменов

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2

Response (JSON format)

{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда Получить состояние аудита Cn

Support multi-thread

Если вызывается команда get cn audit status, следующие параметры должны быть включены:

Получить параметр запроса статуса аудита CnПояснение

Получить параметр запроса статуса аудита Cn
Пояснение

contact_idИдентификатор записи контакта, для которого вы хотите получить статус аудита, может быть введен только 1 contactId на запрос

gtldЕсли вы запрашиваете результат аудита cnnic-gtld, установите этот параметр на 1

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetCnAuditStatusResponse></GetCnAuditStatusResponse>Корневой узел XML-документа ответа

<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<CnAuditStatus></CnAuditStatus>Статус проверки записи аудита CNNIC. Вы можете получить 'обрабатывается' или 'ожидает CNNIC' или 'не удалось'. Если проверка завершится неудачно, мы отправим вам электронное письмо.

<FailedReason></FailedReason>Если аудит не будет пройден, будет отображена причина неудачи.

Получить пример статуса аудита Cn

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid

Response (JSON format)

{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}

Команда создания контакта

Support multi-thread

При вызове команды создания контакта должны быть указаны следующие параметры:

Параметр запроса создания контактаПояснение

Параметр запроса создания контакта
Пояснение

organization (необязательно)Информация об организации

nameИмя

emailПочта

phonenumНомер телефона

phoneccТелефонный код страны

faxnum (необязательно)Номер факса

faxcc (необязательно)Код страны для факса

address1Адрес1

address2 (необязательно)Адрес 2

cityГород

state (необязательно)Регион

zipПочтовый индекс

countryСтрана

XML-тег результатаПояснение

XML-тег результата
Пояснение

<CreateContactResponse></CreateContactResponse>Корневой узел XML-документа ответа

<CreateContactHeader></CreateContactHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<CreateContactContent></CreateContactContent>Новый идентификатор контакта, используется только при статусе "success".

Create Contact Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US

Response (XML format)

<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US

Response (JSON format)

{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}

Команда редактирования контакта

Support multi-thread

При вызове команды редактирования контакта должны быть указаны следующие параметры:

Параметр запроса редактирования контактаПояснение

Параметр запроса редактирования контакта
Пояснение

contact_idИдентификатор контакта, который вы хотите редактировать

organization (необязательно)Информация об организации

nameИмя

emailПочта

phonenumНомер телефона

phoneccТелефонный код страны

faxnum (необязательно)Номер факса

faxcc (необязательно)Код страны для факса

address1Адрес 1

address2 (необязательно)Адрес 2

cityГород

stateРегион

zipПочтовый индекс

countryСтрана

XML-тег результатаПояснение

XML-тег результата
Пояснение

<EditContactResponse></EditContactResponse>Корневой узел XML-документа ответа

<EditContactHeader></EditContactHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<EditContactContent></EditContactContent>Содержимое ответа

<ContactId></ContactId>Идентификатор контакта

Пример редактирования контакта

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response (JSON format)

{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,

success,
,

Команда удаления контакта

Support multi-thread

При вызове команды удаления контакта должны быть указаны следующие параметры:

Параметр запроса удаления контактаПояснение

Параметр запроса удаления контакта
Пояснение

contact_idИдентификатор контакта, который вы хотите удалить, они должны разделяться запятыми

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DeleteContactResponse></DeleteContactResponse>Корневой узел XML-документа ответа

<DeleteContactHeader></DeleteContactHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления контакта

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0

Response (JSON format)

{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда получения списка контактов

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Параметр запроса списка контактовПояснение

Параметр запроса списка контактов
Пояснение

N/AДополнительных параметров не требуется

XML-тег результатаПояснение

XML-тег результата
Пояснение

<ContactListResponse></ContactListResponse>Корневой узел XML-документа ответа

<ContactListHeader></ContactListHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<ContactListContent></ContactListContent>Содержимое ответа

<ContactList></ContactList>Список контактов

<Contact></Contact>Информация контакта

<ContactId></ContactId>Идентификатор контакта

<Organization></Organization>Организация контакта

<Name></Name>Имя

<Email></Email>Почта

<PhoneCc></PhoneCc>Телефонный код страны

<PhoneNum></PhoneNum>Номер телефона

<FaxCc></FaxCc>Код страны для факса

<FaxNum></FaxNum>Номер факса

<Address1></Address1>Адрес 1

<Address2></Address2>Адрес 2

<City></City>Город

<State></State>Регион

<ZipCode></ZipCode>Почтовый индекс

<Country></Country>Страна

<GtldVerified></GtldVerified>статус проверки gTLD

Contact List Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>test street</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list

Response (JSON format)

{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "test street",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}

Команда получения контакта

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Параметр запроса получения контактаПояснение

Параметр запроса получения контакта
Пояснение

contact_idидентификатор контакта

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetContactResponse></GetContactResponse>Корневой узел XML-документа ответа

<GetContactHeader></GetContactHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetContactContent></GetContactContent>Содержимое ответа

<Contact></Contact>Информация контакта

<ContactId></ContactId>Идентификатор контакта

<Organization></Organization>Организация контакта

<Name></Name>Имя

<Email></Email>Почта

<PhoneCc></PhoneCc>Телефонный код страны

<PhoneNum></PhoneNum>Номер телефона

<FaxCc></FaxCc>Код страны для факса

<FaxNum></FaxNum>Номер факса

<Address1></Address1>Адрес 1

<Address2></Address2>Адрес 2

<City></City>Город

<State></State>Регион

<ZipCode></ZipCode>Почтовый индекс

<Country></Country>Страна

<GtldVerified></GtldVerified>статус проверки gTLD

Get Contact Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000

Response (JSON format)

{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "[email protected]",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}

Команда настройки контактов ЕС

Support multi-thread

Если при вызове команды задания настройки контакта ЕС должны быть включены следующие параметры:

Установка параметра запроса настройки контакта ЕСПояснение

Установка параметра запроса настройки контакта ЕС
Пояснение

contact_idИдентификатор контакта, который вы хотите редактировать

country_of_citizenshipДолжен быть членом ЕС, Коды стран-членов включают: AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LI, LT, LU, MT, NL, NO, PL, PT, RO, SK, SI, ES, SE

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetContactEUSettingResponse></SetContactEUSettingResponse>Корневой узел XML-документа ответа

<SetContactEUSettingHeader></SetContactEUSettingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<SetContactEUSettingContent></SetContactEUSettingContent>Содержимое ответа

<ContactId></ContactId>Идентификатор контакта

Set Contact EU Setting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT

Response (JSON format)

{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Команда установки настроек LV контакта

Support multi-thread

При вызове команды настройки установки контактного уровня следует включить следующие параметры:

Установить параметр запроса настройки контакта LVПояснение

Установить параметр запроса настройки контакта LV
Пояснение

contact_idИдентификатор контакта, который вы хотите редактировать

registration_number- Для физических лиц, пожалуйста, введите латвийский идентификационный номер.
- Для компаний и других юридических лиц, пожалуйста, введите номер регистрации, выданный Регистром предприятий Латвии.

vat_number (необязательно)Номер НДС для иностранных юридических лиц, зарегистрированных в странах Европейского союза (в том числе латвийских компаний)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetContactLvSettingResponse></SetContactLvSettingResponse>Корневой узел XML-документа ответа

<SetContactLvSettingHeader></SetContactLvSettingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<SetContactLvSettingContent></SetContactLvSettingContent>Содержимое ответа

<ContactId></ContactId>Идентификатор контакта

Пример задания уровня контакта.

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (JSON format)

{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Set Contact LV Setting Example

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,success,0

Команда получения имени сервера

Support multi-thread

Если вызывается команда получения имени сервера, следующие параметры должны быть включены:

Получение параметра запроса сервера именПояснение

Получение параметра запроса сервера имен
Пояснение

domainДомен, для которого вы хотите получить информацию о серверах имен, за один запрос может быть получена информация только для 1 сервера.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetNsResponse></GetNsResponse>Корневой узел XML-документа ответа

<GetNsHeader></GetNsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<NsContent></NsContent>Содержимое ответа

<Host></Host>Имя хоста сервера

<NsName></NsName>Название сервера

Получить Ns Пример

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com

Response (JSON format)

{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}

Команда добавления сервера имен

Support multi-thread

При вызове команды добавления сервера имен должны быть указаны следующие параметры:

Параметр запроса добавления сервера именПояснение

Параметр запроса добавления сервера имен
Пояснение

hostИмя узла сервера имен, который вы хотите добавить

XML-тег результатаПояснение

XML-тег результата
Пояснение

<AddNsResponse></AddNsResponse>Корневой узел XML-документа ответа

<AddNsHeader></AddNsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<AddNsContent></AddNsContent>Содержимое ответа

<Server></Server>Сервер, который вы установили

<Host></Host>Имя узла нового сервера

<ServerId></ServerId>Идентификатор нового сервера

Пример добавления Ns

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com

Response (JSON format)

{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}

Команда регистрации сервера имен

Support multi-thread

При вызове команды регистрации сервера имен должны быть указаны следующие параметры:

Параметр запроса регистрации сервера именПояснение

Параметр запроса регистрации сервера имен
Пояснение

hostИмя узла вашего собственного сервера имен

ipIP-адрес вашего собственного сервера имен

XML-тег результатаПояснение

XML-тег результата
Пояснение

<RegisterNsResponse></RegisterNsResponse>Корневой узел XML-документа ответа

<RegisterNsHeader></RegisterNsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<RegisterNsContent></RegisterNsContent>Содержимое ответа

<Server></Server>Тег сервера

<Host></Host>Имя узла

<ServerId></ServerId>Идентификатор сервера

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1

Response (XML format)

<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1

Response (JSON format)

{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}

Команда установки IP-адреса сервера имен

Support multi-thread

При вызове команды установки IP-адреса сервера имен должны быть указаны следующие параметры:

Параметр запроса установки IP-адреса сервера именПояснение

Параметр запроса установки IP-адреса сервера имен
Пояснение

server_idИдентификатор имени сервера, который вы хотите изменить

ip0 - ip9IP-адрес, который вы хотите назначить серверу имен, за один запрос можно добавить 9 IP-адресов, они должны быть разделены запятыми

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetNsIpResponse></SetNsIpResponse>Корневой узел XML-документа ответа

<SetNsIpHeader></SetNsIpHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Name Server IP Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response (XML format)

<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response (JSON format)

{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда удаления сервера имен

Support multi-thread

При вызове команды удаления сервера имен должны быть указаны следующие параметры:

Параметр запроса удаления сервера именПояснение

Параметр запроса удаления сервера имен
Пояснение

server_idИдентификатор серверов имен, которые вы хотите удалить, они должны разделяться запятыми

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DeleteNsResponse></DeleteNsResponse>Корневой узел XML-документа ответа

<DeleteNsHeader></DeleteNsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Удалить Ns Пример

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0

Response (JSON format)

{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда для удаления сервера имен по домену

Support multi-thread

Если вызывается команда удаления сервера имен по домену, следующие параметры должны быть включены:

Удаление сервера имен по параметру запроса доменаПояснение

Удаление сервера имен по параметру запроса домена
Пояснение

server_domainИмя сервера имён. Пример: ns1.testnameserver.com

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DeleteNsResponse></DeleteNsResponse>Корневой узел XML-документа ответа

<DeleteNsHeader></DeleteNsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Delete Name Server By Domain Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Response (XML format)

<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Response (JSON format)

{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда получения списка серверов

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Параметр запроса получения списка серверовПояснение

Параметр запроса получения списка серверов
Пояснение

N/AДополнительных параметров не требуется

XML-тег результатаПояснение

XML-тег результата
Пояснение

<ServerListResponse></ServerListResponse>Корневой узел XML-документа ответа

<ServerListHeader></ServerListHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<ServerListContent></ServerListContent>Содержимое ответа

<NameServerList></NameServerList>Список серверов имен

<ServerId></ServerId>Идентификатор сервера

<ServerName></ServerName>Имя сервера

<ServerIp></ServerIp>IP-адрес сервера

Server List Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
          <ServerIp>1.1.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list

Response (JSON format)

{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIps": [
          {
            "Ip": "192.168.1.1"
          },
          {
            "Ip": "1.1.1.1"
          }
        ]
      }
    ]
  }
}

Команда для получения настроек сервера имен домена

Support multi-thread

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

Получить параметр запроса настройки сервера имён доменаПояснение

Получить параметр запроса настройки сервера имён домена
Пояснение

domainДомен, настройки сервера имен которого вы хотите получить, может быть запрошен только для настройки сервера имен домена 1.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetDnsResponse></GetDnsResponse>Корневой узел XML-документа ответа

<GetDnsHeader></GetDnsHeader>Заголовок ответа

<ResponseCode></ResponseCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetDnsContent></GetDnsContent>Содержимое ответа

<NameServerSettings></NameServerSettings>Настройки сервера доменного имени

<Type></Type>Тип сервера доменного имени

Get Domain Nameserver Settings Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com

Response (JSON format)

{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}

Команда получения информации об учетной записи

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Параметр запроса информации об учетной записиПояснение

Параметр запроса информации об учетной записи
Пояснение

N/AДополнительных параметров не требуется

XML-тег результатаПояснение

XML-тег результата
Пояснение

<AccountInfoResponse></AccountInfoResponse>Корневой узел XML-документа ответа

<AccountInfoHeader></AccountInfoHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<AccountInfoContent></AccountInfoContent>Содержимое ответа

<AccountInfo></AccountInfo>Информация учетной записи

<Username></Username>Имя пользователя

<ForumName></ForumName>Имя на форуме

<Contact></Contact>Информация контакта

<Organization></Organization>Организация

<Organization></Organization>Заголовок ответа

<Name></Name>Ваше имя

<Email></Email>Почта

<PhoneCc></PhoneCc>Телефонный код страны

<PhoneNum></PhoneNum>Номер телефона

<Address1></Address1>Адрес 1

<Address2></Address2>Адрес 2

<City></City>Город

<State></State>Регион

<ZipCode></ZipCode>Почтовый индекс

<Country></Country>Страна

<CustomerSince></CustomerSince>Является клиентом с

<AccountLock></AccountLock>Блокировка для учетной записи

<TotalSpending></TotalSpending>Суммарные расходы

<PriceLevel></PriceLevel>Ценовой уровень

<AccountBalance></AccountBalance>Баланс учетной записи

<CustomTimeZone></CustomTimeZone>Часовой пояс клиента

<DefaultSettings></DefaultSettings>Настройки по умолчанию

<DefaultWhois></DefaultWhois>Whois по умолчанию

<DefaultRegistrant></DefaultRegistrant>Регистрирующее лицо по умолчанию

<ContactId></ContactId>Идентификатор контакта

<DefaultAdmin></DefaultAdmin>Администратор по умолчанию

<DefaultTechnical></DefaultTechnical>Технический по умолчанию

<DefaultBilling></DefaultBilling>Биллинг по умолчанию

<Type></Type>Тип сервера имен

<WithAds></WithAds>С рекламой или без нее

Account Information Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <AvatarUrl>test avatar url</AvatarUrl>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info

Response (JSON format)

{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "AvatarUrl": "test avatar url",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}

Команда "Получить баланс счета"

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Получить параметр запроса баланса счетаПояснение

Получить параметр запроса баланса счета
Пояснение

N/AДополнительных параметров не требуется

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetAccountBalanceResponse></GetAccountBalanceResponse>Корневой узел XML-документа ответа

<GetAccountBalanceHeader></GetAccountBalanceHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetAccountBalanceContent></GetAccountBalanceContent>Содержимое ответа

<Balance></Balance>Баланс уч. записи

Get Account Balance Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance

Response (JSON format)

{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}

Установка Whois по умолчанию

Support multi-thread

При вызове команды установки Whois по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки Whois по умолчаниюПояснение

Параметр запроса установки Whois по умолчанию
Пояснение

registrant_contactИнформация регистрирующего лица

admin_contactИнформация об администраторе домена

technical_contactТехническая информация о домене

billing_contactБиллинговая информация домена

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Корневой узел XML-документа ответа

<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default Whois Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (XML format)

<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (JSON format)

{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки серверов имен по умолчанию

Support multi-thread

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

Параметр запроса установки серверов имен по умолчаниюПояснение

Параметр запроса установки серверов имен по умолчанию
Пояснение

ns0 - ns12Серверы имен, которые вы хотите установить

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultNsResponse></SetDefaultNsResponse>Тег ответа установки серверов имен по умолчанию, это корневой узел XML-документа ответа

<SetDefaultNsHeader></SetDefaultNsHeader>Тег заголовка установки серверов имен по умолчанию

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<SetDefaultNsContent></SetDefaultNsContent>Тег содержимого установки серверов имен по умолчанию, используется только при статусе "success"

<Servers></Servers>Информация о серверах, которые вы изменили

<Server></Server>Каждый отдельный сервер

<ServerName></ServerName>Имя сервера

<ServerId></ServerId>Идентификатор сервера

Установить значение по умолчанию Ns Пример

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultNsResponse>
  <SetDefaultNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultNsHeader>
  <SetDefaultNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetDefaultNsContent>
</SetDefaultNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response (JSON format)

{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}

Команда установки парковки по умолчанию

Support multi-thread

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

Параметр запроса установки парковки по умолчаниюПояснение

Параметр запроса установки парковки по умолчанию
Пояснение

with_ads (необязательно)Если вы не хотите рекламных объявлений от стороннего поставщика, укажите в этом параметре значение "no", по умолчанию значение "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultParkingResponse></SetDefaultParkingResponse>Корневой узел XML-документа ответа

<SetDefaultParkingHeader></SetDefaultParkingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default Parking Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no

Response (XML format)

<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no

Response (JSON format)

{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки перенаправления по умолчанию

Support multi-thread

При вызове команды установки перенаправления по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки перенаправления по умолчаниюПояснение

Параметр запроса установки перенаправления по умолчанию
Пояснение

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Корневой узел XML-документа ответа

<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default Forwarding Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com

Response (XML format)

<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com

Response (JSON format)

{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки скрытого перенаправления по умолчанию

Support multi-thread

При вызове команды установки скрытого перенаправления по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки скрытого перенаправления по умолчаниюПояснение

Параметр запроса установки скрытого перенаправления по умолчанию
Пояснение

stealth_title (необязательно)Заголовок страницы

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultStealthResponse></SetDefaultStealthResponse>Корневой узел XML-документа ответа

<SetDefaultStealthHeader></SetDefaultStealthHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default Stealth Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com

Response (XML format)

<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com

Response (JSON format)

{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки хостинга по умолчанию

Support multi-thread

При вызове команды установки хостинга по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки хостинга по умолчаниюПояснение

Параметр запроса установки хостинга по умолчанию
Пояснение

hosting_typeТип желаемого хостинга по умолчанию, можно выбрать "advanced" или "basic"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultHostingResponse></SetDefaultHostingResponse>Корневой узел XML-документа ответа

<SetDefaultHostingHeader></SetDefaultHostingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default Hosting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced

Response (XML format)

<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced

Response (JSON format)

{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки DNS по умолчанию

Support multi-thread

При вызове команды установки DNS по умолчанию должны быть указаны следующие параметры:

Эта команда устарела и не рекомендуется, вместо нее используйте команду Set Default DNS2.

Параметр запроса установки DNS по умолчаниюПояснение

Параметр запроса установки DNS по умолчанию
Пояснение

main_record_typeТип главной записи

main_recordУкажите запись DNS для вашего домена

main_txt (необязательно)Укажите запись TXT для вашего домена. Если основной тип записи (main_record_type) AAAA, и указана основная запись 2 (main_record2), вы можете настроить до 3 основных текстовых (main_txt) записей, в других случаях — до 4.

main_record2Основная запись 2, используется только когда "main_record_type" имеет значение "aaaa". Ее значение должно быть в формате IPv4.

subdomain0 - subdomain99 (необязательно)Записи поддоменов

sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена

sub_record0 - sub_record99 (необязательно)Целевой IP-адрес или URL

mx_host0 - mx_host2 (необязательно)Укажите адрес почтового узла для домена, distance0 — высший приоритет

mx_distance0 - mx_distance2 (необязательно)Distance0 — высший приоритет

ttl (необязательно)Время жизни (time to live)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultDnsResponse></SetDefaultDnsResponse>Корневой узел XML-документа ответа

<SetDefaultDnsHeader></SetDefaultDnsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default DNS Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)

<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)

{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки DNS2 по умолчанию

Support multi-thread

При вызове команды установки DNS по умолчанию должны быть указаны следующие параметры:

Параметры запроса Set Default DNS2Пояснение

Параметры запроса Set Default DNS2
Пояснение

main_record_type0 - main_record_type19Тип главной записи

main_record0 - main_record19Укажите запись DNS для вашего домена

main_recordx0 - main_recordx19Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record типа «a», «aaaa», «cname», «forward», «txt», «mx», «stealth», «email»

subdomain0 - subdomain99 (необязательно)Записи поддоменов

sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена

sub_record0 - sub_record99 (необязательно)IP-адрес или узел назначения поддомена

sub_recordx0 - subdo_recordx99Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для sub_record_type типа «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»

ttl (необязательно)Время жизни (time to live)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultDnsResponse></SetDefaultDnsResponse>Корневой узел XML-документа ответа

<SetDefaultDnsHeader></SetDefaultDnsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default DNS2 Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)

<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)

{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки перенаправления Email по умолчанию

Support multi-thread

При вызове команды установки перенаправления Email по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки перенаправления Email по умолчаниюПояснение

Параметр запроса установки перенаправления Email по умолчанию
Пояснение

username0 - username9Имя пользователя, используется только, если в "forward_type" указано "forward"

exist_email0 - exist_email9Существующий адрес электронной почты, используется только, когда в "forward_type" указано "forward"

mx_host0 - mx_host2Почтовый узел, используется только, когда в "forward_type" указано "mx"

mx_distance0 - mx_distance2Distance0 — высший приоритет, используется только, когда в "forward_type" указано "mx"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Корневой узел XML-документа ответа

<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Default Email Forward Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]

Response (XML format)

<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]

Response (JSON format)

{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда сброса значения по умолчанию

Support multi-thread

При вызове команды сброса значения по умолчанию должны быть указаны следующие параметры:

Параметр запроса сброса значения по умолчаниюПояснение

Параметр запроса сброса значения по умолчанию
Пояснение

serviceСлужба, которую вы хотите стереть, может быть «forward», «stealth», «email_forwarding», «dns» и «nameservers»

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Корневой узел XML-документа ответа

<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Clear Default Setting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers

Response (XML format)

<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers

Response (JSON format)

{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки опции продления по умолчанию

Support multi-thread

При вызове команды установки опции продления по умолчанию должны быть указаны следующие параметры:

Параметр запроса установки опции продления по умолчаниюПояснение

Параметр запроса установки опции продления по умолчанию
Пояснение

renew_optionМожет быть указано "donot", "auto", "reset"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Корневой узел XML-документа ответа

<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример установки опции продления по умолчанию

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto

Response (JSON format)

{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда создания папки

Support multi-thread

При вызове команды создания папки должны быть указаны следующие параметры:

Параметр запроса создания папкиПояснение

Параметр запроса создания папки
Пояснение

folder_nameНазвание папки, которую вы хотите создать

XML-тег результатаПояснение

XML-тег результата
Пояснение

<FolderCreateResponse></FolderCreateResponse>Корневой узел XML-документа ответа

<FolderCreateHeader></FolderCreateHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<FolderCreateContent></FolderCreateContent>Содержимое ответа

<FolderName></FolderName>название папки

<FolderId></FolderId>Идентификатор новой папки

Create Folder Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new

Response (XML format)

<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new

Response (JSON format)

{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}

Команда удаления папки

Support multi-thread

При вызове команды установки данных Whois должны быть указаны следующие параметры:

Параметр запроса удаления папкиПояснение

Параметр запроса удаления папки
Пояснение

folder_idИдентификатор папок, которые вы хотите удалить, они должны разделяться запятыми

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DeleteFolderResponse></DeleteFolderResponse>Корневой узел XML-документа ответа

<DeleteFolderHeader></DeleteFolderHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Пример удаления папки

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1

Response (JSON format)

{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}

Команда установки Whois для папки

Support multi-thread

При вызове команды установки Whois для папки должны быть указаны следующие параметры:

Параметр запроса установки Whois для папкиПояснение

Параметр запроса установки Whois для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

registrant_contactИнформация регистрирующего лица

admin_contactИнформация об администраторе домена

technical_contactТехническая информация о домене

billing_contactБиллинговая информация домена

enable (необязательно)Если вы хотите применить эти настройки Whois для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать эти настройки Whois для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderWhoisResponse></SetFolderWhoisResponse>Корневой узел XML-документа ответа

<SetFolderWhoisHeader></SetFolderWhoisHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Whois Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (XML format)

<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response (JSON format)

{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки серверов имен для папки

Support multi-thread

При вызове команды установки серверов имен для папки должны быть указаны следующие параметры:

Параметр запроса установки серверов имен для папкиПояснение

Параметр запроса установки серверов имен для папки
Пояснение

fold_idИдентификатор папки, которую вы хотите изменить, за один запрос можно изменить только 1 папку

enable (необязательно)Если вы хотите применить эти настройки серверов имен для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать эти настройки серверов имен для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderNsResponse></SetFolderNsResponse>Тег ответа установки серверов имен для папки, это корневой узел XML-документа ответа

<SetFolderNsHeader></SetFolderNsHeader>Тег заголовка ответа установки серверов имен для папки

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<SetFolderNsContent></SetFolderNsContent>Тег содержимого установки серверов имен для папки, используется, только когда status имеет значение "success"

<Servers></Servers>Информация о серверах, которые вы изменили

<Server></Server>Каждый отдельный сервер

<ServerName></ServerName>Имя сервера

<ServerId></ServerId>Идентификатор сервера

Пример папки Ns

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetFolderNsResponse>
  <SetFolderNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNsHeader>
  <SetFolderNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetFolderNsContent>
</SetFolderNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response (JSON format)

{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}

Команда установки парковки для папки

Support multi-thread

При вызове команды установки парковки для папки должны быть указаны следующие параметры:

Параметр запроса установки парковки для папкиПояснение

Параметр запроса установки парковки для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить, за один запрос можно изменить только 1 папку

enable (необязательно)Если вы хотите применить эти настройки парковки для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать настройки парковки для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderParkingResponse></SetFolderParkingResponse>Корневой узел XML-документа ответа

<SetFolderParkingHeader></SetFolderParkingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Parking Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no

Response (XML format)

<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no

Response (JSON format)

{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки перенаправления для папки

Support multi-thread

При вызове команды установки перенаправления для папки должны быть указаны следующие параметры:

Параметр запроса установки перенаправления для папкиПояснение

Параметр запроса установки перенаправления для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

enable (необязательно)Если вы хотите применить эти настройки перенаправления для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать настройки перенаправления для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderForwardingResponse></SetFolderForwardingResponse>Корневой узел XML-документа ответа

<SetFolderForwardingHeader></SetFolderForwardingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Forwarding Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes

Response (XML format)

<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes

Response (JSON format)

{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки скрытого перенаправления для папки

Support multi-thread

При вызове команды установки скрытого перенаправления для папки должны быть указаны следующие параметры:

Параметр запроса установки скрытого перенаправления для папкиПояснение

Параметр запроса установки скрытого перенаправления для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

stealth_title (необязательно)Заголовок страницы

enable (необязательно)Если вы хотите применить эти настройки скрытого перенаправления для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать настройки скрытого перенаправления для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderStealthResponse></SetFolderStealthResponse>Корневой узел XML-документа ответа

<SetFolderStealthHeader></SetFolderStealthHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Stealth Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes

Response (XML format)

<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes

Response (JSON format)

{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки хостинга для папки

Support multi-thread

При вызове команды установки хостинга для папки должны быть указаны следующие параметры:

Параметр запроса установки хостинга для папкиПояснение

Параметр запроса установки хостинга для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

hosting_typeТип желаемого хостинга, можно выбрать "advanced" или "basic"

enable (необязательно)Если вы хотите применить эти настройки хостинга для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

even (необязательно)Если вы хотите синхронизировать настройки хостинга для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderHostingResponse></SetFolderHostingResponse>Корневой узел XML-документа ответа

<SetFolderHostingHeader></SetFolderHostingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Hosting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response (XML format)

<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response (JSON format)

{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки DNS для папки

Support multi-thread

При вызове команды установки DNS для папки должны быть указаны следующие параметры:

Эта команда устарела и не рекомендуется, вместо нее используйте команду Set Folder DNS2.

Параметр запроса установки DNS для папкиПояснение

Параметр запроса установки DNS для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

main_record_typeТип главной записи

main_recordУкажите запись DNS для вашего домена

with_ads (необязательно)Укажите запись TXT для вашего домена. Если основной тип записи (main_record_type) AAAA, и указана основная запись 2 (main_record2), вы можете настроить до 3 основных текстовых (main_txt) записей, в других случаях — до 4.

subdomain0 - subdomain99 (необязательно)Subdomain records (необязательно)

sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена

sub_record0 - sub_record99 (необязательно)Целевой IP-адрес или URL

mx_host0 - mx_host2 (необязательно)Укажите адрес почтового узла для домена, distance0 — высший приоритет

mx_distance0 - mx_distance2 (необязательно)Distance0 — высший приоритет

ttl (необязательно)Время жизни (time to live)

enable (необязательно)Если вы хотите применить эти настройки DNS для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать настройки DNS для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderDnsResponse></SetFolderDnsResponse>Корневой узел XML-документа ответа

<SetFolderDnsHeader></SetFolderDnsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder DNS Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)

<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)

{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда Set Folder DNS2

Support multi-thread

При вызове команды set folder DNS2 необходимо указать следующие параметры:

Параметры запроса Set Folder DNS2Пояснение

Параметры запроса Set Folder DNS2
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

main_record_type0 - main_record_type19Тип основной записи должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»

main_record0 - main_record19Укажите запись DNS для вашего домена

main_recordx0 - main_recordx19Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для main_record_type типа «forward», «mx», «stealth», «email»

subdomain0 - subdomain99 (необязательно)Subdomain records (необязательно)

sub_record_type0 - sub_record_type99 (необязательно)Тип записей поддомена должен быть «a», «aaaa», «cname», «forward», «txt», «srv», «mx», «stealth», «email»

sub_record0 - sub_record99 (необязательно)Целевой IP-адрес или URL

sub_recordx0 - sub_recordx99 (необязательно)Приоритет MX, тип переадресации, заголовок скрытого перенаправления или псевдоним эл. почты, необходимые для sub_record_type типа «forward», «mx», «stealth», «email»

ttl (необязательно)Время жизни (time to live)

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderDnsResponse></SetFolderDnsResponse>Корневой узел XML-документа ответа

<SetFolderDnsHeader></SetFolderDnsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Установить папку Dns2 Пример

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)

{
  "SetFolderDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда установки перенаправления Email для папки

Support multi-thread

При вызове команды установки перенаправления Email для папки должны быть указаны следующие параметры:

Параметр запроса установки перенаправления Email для папкиПояснение

Параметр запроса установки перенаправления Email для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

username0 - username9Имя пользователя, используется только, если в "forward_type" указано "forward"

exist_email0 - exist_email9Существующий адрес электронной почты, используется только, когда в "forward_type" указано "forward"

mx_host0 - mx_host2Почтовый узел, используется только, когда в "forward_type" указано "mx"

mx_distance0 - mx_distance2Distance0 — высший приоритет, используется только, когда в "forward_type" указано "mx"

enable (необязательно)Если вы хотите применить эти настройки для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать эти настройки для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Корневой узел XML-документа ответа

<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Email Forward Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]

Response (XML format)

<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]

Response (JSON format)

{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда сброса значения для папки

Support multi-thread

При вызове команды сброса значения для папки должны быть указаны следующие параметры:

Параметр запроса сброса значения для папкиПояснение

Параметр запроса сброса значения для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

serviceСлужба, которую вы хотите стереть, может быть «forward», «stealth», «email_forwarding», «dns» и «nameservers»

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Корневой узел XML-документа ответа

<SetClearFolderSettingHeader></SetClearFolderSettingHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Clear Folder Setting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers

Response (XML format)

<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers

Response (JSON format)

{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки названия папки

Support multi-thread

При вызове команды установки названия папки должны быть указаны следующие параметры:

Параметр запроса установки названия папкиПояснение

Параметр запроса установки названия папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить

folder_nameНовое название папки

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetFolderNameResponse></SetFolderNameResponse>Корневой узел XML-документа ответа

<SetFolderNameHeader></SetFolderNameHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Set Folder Name Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new

Response (XML format)

<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new

Response (JSON format)

{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда установки опции продления для папки

Support multi-thread

При вызове команды установки опции продления для папки должны быть указаны следующие параметры:

Параметр запроса установки опции продления для папкиПояснение

Параметр запроса установки опции продления для папки
Пояснение

folder_idИдентификатор папки, которую вы хотите изменить, за один запрос можно изменить только 1 папку

renew_optionОпция обновления, которую вы хотите установить в папке; это может быть "не обновлять", "автоматическое обновление" или "сброс".

enable (необязательно)Если вы хотите применить эти настройки продления для всех доменов, которые вы в будущем переместите в эту папку, вы можете указать в этом параметре "yes"

sync (необязательно)Если вы хотите синхронизировать эти настройки продления для всех доменов в этой папке, вы можете указать в этом параметре "yes"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<Response></Response>Корневой узел XML-документа ответа

<ResponseHeader></ResponseHeader>Заголовок ответа

<ResponseCode></ResponseCode>Код ответа, "0" при успешном завершении, "-1" при сбое

<Error></Error>Информация об ошибке, используется только при коде ответа "-1"

Set Folder Renew Option Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto

Response (XML format)

<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto

Response (JSON format)

{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда списка папок

Support multi-thread

Эта команда доступна только в формате XML и JSON:

Параметр запроса списка папокПояснение

Параметр запроса списка папок
Пояснение

N/AДополнительных параметров не требуется

<FolderListResponse></FolderListResponse>Корневой узел XML-документа ответа

<FolderListHeader></FolderListHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<FolderListContent></FolderListContent>Содержимое ответа

<FolderList></FolderList>Список папок

<FolderId></FolderId>Идентификатор папки

<FolderName></FolderName>Название папки

<DefaultWhois></DefaultWhois>Whois по умолчанию

<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Статус включения Whois по умолчанию (Whois enable)

<DefaultRegistrant></DefaultRegistrant>Регистрирующее лицо по умолчанию

<ContactId></ContactId>Идентификатор контакта

<DefaultAdmin></DefaultAdmin>Администратор по умолчанию

<DefaultTechnical></DefaultTechnical>Техническая информация по умолчанию

<DefaultBilling></DefaultBilling>Биллинговая информация по умолчанию

<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Статус включения сервера имен по умолчанию (name server enable)

<NameServerSettings></NameServerSettings>Значение сервера имен

<Type></Type>Тип сервера имен

<WithAds></WithAds>С рекламой или без нее

<DefaultRenewOption></DefaultRenewOption>Настройка продления по умолчанию

<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Статус включения настройки продления по умолчанию

<RenewOption></RenewOption>Настройка продления

<DefaultTransferLock></DefaultTransferLock>Значение блокировки переноса по умолчанию

<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Статус включения блокировки переноса по умолчанию

<LockStatus></LockStatus>Статус блокировки

Folder List Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>Yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list

Response (JSON format)

{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}

Команда добавления запроса на отложенный заказ

Support multi-thread

При вызове команды добавления запроса на отложенный заказ должны быть указаны следующие параметры:

Параметр запроса на добавления запроса на отложенный заказПояснение

Параметр запроса на добавления запроса на отложенный заказ
Пояснение

domainДомены, которые вы хотите добавить и согласны оплатить, если Dynadot перехватит их, за один запрос можно добавить 100 доменов, они должны быть разделены запятыми

XML-тег результатаПояснение

XML-тег результата
Пояснение

<AddBackorderRequestResponse></AddBackorderRequestResponse>Корневой узел XML-документа ответа

<AddBackorderRequestHeader></AddBackorderRequestHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Add Backorder Request Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response (XML format)

<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response (JSON format)

{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

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

Support multi-thread

При вызове команды удаления запроса на отложенный заказ должны быть указаны следующие параметры:

Параметр запроса на удаление запроса на отложенный заказПояснение

Параметр запроса на удаление запроса на отложенный заказ
Пояснение

domainДомены, которые вы хотите удалить из запроса на отложенный заказ, за один запрос можно удалить 100 доменов, они должны быть разделены запятыми

XML-тег результатаПояснение

XML-тег результата
Пояснение

<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Корневой узел XML-документа ответа

<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Delete Backorder Request Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com

Response (XML format)

<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com

Response (JSON format)

{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Команда запроса списка отложенных заказов

Support multi-thread

Вызов команды получения списка отложенных заказов возвращает список отложенных заказов для указанной учетной записи. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса списка отложенных заказовПояснение

Параметр запроса списка отложенных заказов
Пояснение

start_dateНачальная дата освобождения доменов, гггг-мм-дд, например 2015-05-05

end_dateДата окончания освобождения доменов, гггг-мм-дд, например 2015-05-05

XML-тег результатаПояснение

XML-тег результата
Пояснение

<BackorderRequestListResponse></BackorderRequestListResponse>Корневой узел XML-документа ответа

<BackorderRequestListHeader></BackorderRequestListHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<BackorderRequestListContent></BackorderRequestListContent>Содержимое ответа

<BackorderRequestList></BackorderRequestList>Список запроса отложенных заказов

<BackorderRequest></BackorderRequest>Запрос на отложенные заказы

<Domain></Domain>Домен из вашего списка

<CutoffTime></CutoffTime>Конечный срок для удаления запроса в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

<BackorderRequestStatus></BackorderRequestStatus>Статус процесса перехвата домена

Пример запроса списка отложенных заказов

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (JSON format)

{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active

Команда получения списка открытых аукционов

Support multi-thread

Вызов команды получения открытых аукционов вернет список активных на данный момент аукционов. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса на получение списка открытых аукционовПояснение

Параметр запроса на получение списка открытых аукционов
Пояснение

currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США

typeВы хотите увидеть тип аукциона, он должен быть "expired", "user", "backorder", или "registry_expired", "registrar",, если вы хотите получить более одного типа аукциона, вы можете использовать "," для разделения каждого типа аукциона.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Тег ответа получения открытых аукционов. Это корневой узел XML-документа ответа

<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Заголовок получения открытых аукционов

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetOpenAuctionsContent></GetOpenAuctionsContent>Тег содержимого получения открытых аукционов, используется только при статусе "success"

<Auction></Auction>Тег аукционного лота, используется только при статусе "success"

<AuctionId></AuctionId>Идентификатор аукциона

<Domain></Domain>Доменное имя аукциона

<BidPrice></BidPrice>Размер текущей ставки аукциона

<BidPriceCurrency></BidPriceCurrency>Валюта ставки

<Bids></Bids>Количество ставок аукциона

<EndTime></EndTime>Время окончания аукциона

<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

<Revenue></Revenue>Доход с домена

<RevenueCurrency></RevenueCurrency>Валюта дохода

<Visitors></Visitors>Посетители домена

<Links></Links>Внешние ссылки

<Age></Age>Возраст домена

Get Open Auctions Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_auctions&currency=usd&type=expired

Response (XML format)

<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>

Запрос (формат csv)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions¤cy=usd&type=expired

Ответ

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_open_auctions&currency=usd&type=expired

Response (JSON format)

{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        }
        ...
    ]
}

Команда получения подробностей аукциона

Support multi-thread

Вызов команды получения деталей аукциона вернет детали указанного аукциона. Эта команда доступна только в форматах XML и JSON. Если вы вызываете эту команду, следующие параметры должны быть включены:

Параметр запроса получения подробностей об аукционеПояснение

Параметр запроса получения подробностей об аукционе
Пояснение

domainДоменное имя аукциона, IDN (международное доменное имя) должно использовать punycode, например "xn--wkccg.com". Вы можете получить более одного аукциона, каждый домен должен быть разделен запятой.

currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Тег ответа получения подробностей об аукционе, это корневой узел XML-документа ответа

<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Заголовок получения сведений об аукционе отложенных заказов

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetAuctionDetailsContent></GetAuctionDetailsContent>Тег содержимого получения подробностей об аукционе, используется только при статусе "success"

<AuctionStatusId></AuctionStatusId>Идентификатор статуса аукциона: '0' для В процессе, '1' для Отменено пользователем, '2' для Отменено администратором, '3' для Отменено продлением, '4' для Завершено, '5' для Отменено передачей

<AuctionStatus></AuctionStatus>Статус аукциона

<UserIsHighBid></UserIsHighBid>Является ли ставка пользователя самой высокой

<YourCurrentBid></YourCurrentBid>Ваша текущая ставка в указанном аукционе. Если вы не делали ставок, будет передано '-1'

<YourProxyBid></YourProxyBid>Ваша максимальная ставка (proxy bid) в указанном аукционе. Если вы не делали ставок, будет передано '-1'

<AuctionId></AuctionId>Идентификатор аукциона

<Domain></Domain>Доменное имя аукциона

<BidPrice></BidPrice>Размер текущей ставки аукциона

<BidPriceCurrency></BidPriceCurrency>Валюта ставки

<Bids></Bids>Количество ставок аукциона

<EndTime></EndTime>Время окончания аукциона

<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

<IsPremium></IsPremium>Является ли это премиальным доменом

<RenewalPrice></RenewalPrice>Цена продления

Get Auction Details Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Response (JSON format)

{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}

Команда получения ставок по лоту

Support multi-thread

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

Получить параметр запроса ставок на аукционеПояснение

Получить параметр запроса ставок на аукционе
Пояснение

currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetAuctionBidsResponse></GetAuctionBidsResponse>Тег ответа на запрос торговых предложений, это корневой узел ответа XML документа

<GetAuctionBidsHeader></GetAuctionBidsHeader>Получить заголовок торговых предложений на аукционе

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetAuctionBidsContent></GetAuctionBidsContent>Тег для получения контента торговых ставок, используется только при состоянии "success"

<BidList></BidList>Список ставок

<Bid></Bid>Лот тендера

<BidId></BidId>ID заявки

<AuctionId></AuctionId>Идентификатор аукциона

<AccountId></AccountId>ID аккаунта

<Domain></Domain>Доменное имя аукциона

<DomainUtf></DomainUtf>Utf название доменного аукциона

<AuctionType></AuctionType>Тип аукциона

<IsIdn></IsIdn>Если это доменное имя является интернационализированным доменным именем

<CurrentBid></CurrentBid>Текущая цена ставки на аукционе

<YourStatus></YourStatus>Статус вашей ставки на аукционе

<ProxyBid></ProxyBid>Ваша ставка-посредник для аукциона

<ActiveBidders></ActiveBidders>Количество участников торгов, которые принимают участие в этом аукционе

<TimeLeft></TimeLeft>оставшееся время для аукциона

<EndTime></EndTime>Конечное время аукциона

<EndTimestamp></EndTimestamp>Метка времени окончания аукциона

Get Auction Bids Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&ampcurrency=usd

Response (XML format)

<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&ampcurrency=usd

Response (JSON format)

{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}

Команда регистрации ставки на аукционный лот

Support multi-thread

Вызов команды регистрацию ставки на аукционный лот оформит ставку на указанный лот аукциона. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса на регистрацию ставки на аукционный лотПояснение

Параметр запроса на регистрацию ставки на аукционный лот
Пояснение

domainДоменное имя аукциона, для IDN (интернационализированные доменные имена) следует использовать пьюникод, например «xn--wkccg.com»

bid_amountСумма вашей ставки для аукциона, валюта по умолчанию — доллар США, вы также можете указать ее с помощью параметра валюты ниже

currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Тег ответа регистрации ставки, это корневой узел XML-документа ответа

<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Заголовок регистрации ставки

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Domain Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (XML format)

<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>

Запрос (формат csv)

https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd

Ответ

ok,success

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (JSON format)

{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}

Команда получения закрытых аукционов

Support multi-thread

Вызов команды получения закрытых аукционов возвращает список закрытых аукционов для указанной учетной записи. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения закрытых аукционовПояснение

Параметр запроса получения закрытых аукционов
Пояснение

start_dateДата начала аукциона, гггг-мм-дд, например 2015-05-05

end_dateДата окончания аукциона, гггг-мм-дд, например 2015-05-05

currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Тег ответа получения закрытых аукционов, это корневой узел XML-документа ответа

<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Заголовок получения закрытых аукционов

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetClosedAuctionsContent></GetClosedAuctionsContent>Тег содержимого получения закрытых аукционов, используется только при статусе "success"

<Auction></Auction>Тег аукционного лота, используется только при статусе "success"

<AuctionId></AuctionId>Идентификатор аукциона

<Domain></Domain>Доменное имя аукциона

<AuctionStatusId></AuctionStatusId>Идентификатор статуса аукциона, «0» — в процессе, «1» — закрыт пользователем, «2» — закрыт администратором, «3» — закрыт из-за продления, «4» — закрыт по истечению времени, «5» — закрыт из-за переноса к другому регистратору

<AuctionStatus></AuctionStatus>Статус аукциона

<BidPrice></BidPrice>Размер текущей ставки аукциона

<BidPriceCurrency></BidPriceCurrency>Валюта ставки

<Bids></Bids>Количество ставок аукциона

<AuctionWonStatus></AuctionWonStatus>Выиграл ли пользователь этот аукцион

<YourHighBid></YourHighBid>Ваша высшая ставка на этом аукционе

<YourProxyBid></YourProxyBid>Ваша прокси-ставка для этих торгов

Пример получения закрытых аукционов

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (JSON format)

{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0

Команда получения открытых аукционов по отложенным заказам(Устарело, используйте команду get_open_auctions)

Support multi-thread

Вызов команды получения открытых аукционов по отложенным заказам возвращает список активных аукционов по отложенным заказам. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения открытых аукционов по отложенным заказамПояснение

Параметр запроса получения открытых аукционов по отложенным заказам
Пояснение

currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Тег ответа получения открытых торгов по отложенным заказам, это корневой узел XML-документа ответа

<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Заголовок получения открытых аукционов по отложенным заказам

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Тег содержимого получения открытых торгов по отложенным заказам, используется только при статусе "success"

<Auction></Auction>Тег аукционного лота, используется только при статусе "success"

<AuctionId></AuctionId>Идентификатор аукциона

<Domain></Domain>Доменное имя аукциона

<BidPrice></BidPrice>Размер текущей ставки аукциона

<BidPriceCurrency></BidPriceCurrency>Валюта ставки

<Bids></Bids>Количество ставок аукциона

<EndTime></EndTime>Время окончания аукциона

<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

Get Open Backorder Auctions Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd

Response (XML format)

<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>

Запрос (формат csv)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions¤cy=usd

Ответ

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.

Команда получения сведений об аукционе по отложенному заказу

Support multi-thread

При вызове команды получения деталей аукциона задней связи будет возвращена информация о указанном аукционе. Эта команда доступна только в форматах XML и JSON. Если вы вызываете эту команду, следующие параметры должны быть включены:

Параметр запроса получения подробностей об аукционеПояснение

Параметр запроса получения подробностей об аукционе
Пояснение

domainДоменное имя аукциона по отложенному заказу, для IDN (интернационализированные доменные имена) следует использовать пьюникод, например «xn--wkccg.com»

currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Тег ответа получения подробностей об аукционе, это корневой узел XML-документа ответа

<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Заголовок ответа получения подробностей об аукционе

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<AuctionStatus></AuctionStatus>Статус аукциона

<AuctionId></AuctionId>Идентификатор аукциона

<Domain></Domain>Доменное имя аукциона

<BidPrice></BidPrice>Размер текущей ставки аукциона

<BidPriceCurrency></BidPriceCurrency>Валюта ставки

<Bids></Bids>Количество ставок аукциона

<EndTime></EndTime>Время окончания аукциона

<EndTimestamp></EndTimestamp>Дата окончания аукциона в в формате времени Unix (в миллисекундах с полуночи UTC 1 января 1970 года)

<Revenue></Revenue>Доход с домена

<RevenueCurrency></RevenueCurrency>Валюта дохода

<Visitors></Visitors>Посетители домена

<Links></Links>Внешние ссылки

<Age></Age>Возраст домена

<UserIsHighBid></UserIsHighBid>Является ли ставка пользователя самой высокой

<YourCurrentBid></YourCurrentBid>Ваша текущая ставка в указанном аукционе. Если вы не делали ставок, будет передано '-1'

Get Backorder Auction Details Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd

Response (JSON format)

{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}

Команда размещения ставки на аукционе отложенных заказов

Support multi-thread

Вызов команды размещения ставки на аукционе по отложенным заказам приведет к размещению ставки на указанных торгах по отложенному заказу. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса размещения ставки на аукционе по отложенному заказуПояснение

Параметр запроса размещения ставки на аукционе по отложенному заказу
Пояснение

currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Тег ответа регистрации ставки, это корневой узел XML-документа ответа

<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Заголовок регистрации ставки

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

Place Backorder Auction Bid Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (XML format)

<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (JSON format)

{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,success

Команда получения закрытых аукционов по отложенным заказам

Support multi-thread

Вызов команды получения закрытых аукционов по отложенным заказам возвращает список закрытых аукционов по отложенным заказам для указанной учетной записи. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса получения закрытых аукционов по отложенным заказамПояснение

Параметр запроса получения закрытых аукционов по отложенным заказам
Пояснение

start_dateДата начала аукциона, гггг-мм-дд, например 2015-05-05

end_dateДата окончания аукциона, гггг-мм-дд, например 2015-05-05

currency (необязательно)Валюта вашей ставки, она должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Тег ответа получения закрытых аукционов, это корневой узел XML-документа ответа

<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Заголовок получения закрытых аукционов

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Тег содержимого получения закрытых аукционов, используется только при статусе "success"

<Auction></Auction>Тег аукционного лота, используется только при статусе "success"

<YourHighBid></YourHighBid>Ваша высшая ставка на этом аукционе

<YourProxyBid></YourProxyBid>Ваша прокси-ставка для этих торгов

<AuctionId></AuctionId>Идентификатор аукциона

<Domain></Domain>Доменное имя аукциона

<AuctionStatus></AuctionStatus>Статус аукциона

<BidPrice></BidPrice>Размер текущей ставки аукциона

<BidPriceCurrency></BidPriceCurrency>Валюта ставки

<Bids></Bids>Количество ставок аукциона

Получить примеры закрытых аукционов ожидающих заказов

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (JSON format)

{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0

Получить команду истекших закрытых доменов

Support multi-thread

Вызов команды получения истекших доменов, продаваемых по сниженной цене, приведет к получению истекших доменов, продаваемых по сниженной цене. Эта команда доступна только в форматах XML и JSON. Если при вызове этой команды должны быть включены следующие параметры:

Получить параметр запроса устаревших закрытых доменовПояснение

Получить параметр запроса устаревших закрытых доменов
Пояснение

currency(optional)Валюта результатов возврата должна быть "usd", "eur"или "cny", валюта по умолчанию - доллар США.

domain(optional)Добавьте этот параметр, если хотите запросить закрытый домен

count_per_page (optional)Сколько сущностей отображается на странице

page_index (optional)Какие объекты страницы вы хотите просмотреть?

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Метка ответа истекших закрытых доменов, это корневой узел ответа документа XML

<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Получить заголовок устаревших ликвидационных доменов

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Тег содержимого, используется только при успешном статусе

<CloseoutItem></CloseoutItem>Распродажный товар

<DomainName></DomainName>Доменное имя

<DomainNameUtf></DomainNameUtf>Доменное имя в формате utf

<CurrentPrice></CurrentPrice>текущая цена

<isIdn></isIdn>Будь то доменное имя idn

<EndTimeStamp></EndTimeStamp>Дата окончания аукциона в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года)

<RenewalPrice></RenewalPrice>Цена продления

<ExpiredRevenue></ExpiredRevenue>Выручка от ликвидации

<DynaAppraisal></DynaAppraisal>ДинаОценка

<InboundLinks></InboundLinks>Внешние ссылки

<MonthlyVisitors></MonthlyVisitors>Посетители домена

<Currency></Currency>валюта

Get Expired Closeout Domains Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd

Response (JSON format)

{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}

Купить просроченный закрывающий доменный командный файл

Support multi-thread

Вызов команды Buy Expired Closeout Domain купит указанное имя домена. Эта команда доступна только в формате XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Купить параметр запроса домена распродажи, истекшийПояснение

Купить параметр запроса домена распродажи, истекший
Пояснение

domainДомен, который вы хотите купить, можно ввести только 1 домен за запрос

currency(optional)Валюта результатов возврата должна быть "usd", "eur"или "cny", валюта по умолчанию - доллар США.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Тег приобретения домена закрытого склада, который истек, это корневой узел ответа XML документа.

<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Купить заголовок истекшего домена на распродаже

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

Buy Expired Closeout Domain Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com

Response (JSON format)

{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}

Команда получения списка

Support multi-thread

Если вызывается команда получения списков, следующие параметры должны быть включены:

Получить параметр запроса спискаПояснение

Получить параметр запроса списка
Пояснение

currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США

exclude_pending_sale (необязательно)Если вы не хотите получать заблокированные списки ожидающих продаж, должна быть установлена "yes",, по умолчанию - "no".

show_other_registrar (необязательно)Если вы хотите получить другие списки регистраторов, он должен быть "yes",, по умолчанию "no"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetListingsResponse></GetListingsResponse>Корневой узел XML-документа ответа

<GetListingsHeader></GetListingsHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetListingsContent></GetListingsContent>Содержание списка

<Listing></Listing>Содержание перечисления элементов

<ListingId></ListingId>Идентификатор списка

<Domain></Domain>Доменное имя

<Price></Price>Цена

<InBoundLinks></InBoundLinks>Количество входящих ссылок

<Age></Age>Возраст

Get Listings Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings

Response (JSON format)

{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No"
      }
    ]
  }
}

Команда получения элемента списка

Support multi-thread

При вызове команды получения элемента списка должны быть включены следующие параметры:

Получить параметр запроса элемента спискаПояснение

Получить параметр запроса элемента списка
Пояснение

domainИмя домена, для которого вы хотите получить детали, можно вводить только один домен 1 за запрос

currency (необязательно)Валюта возвращаемого ответа, должна быть "usd", "eur", или "cny", по умолчанию — доллар США

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetListingItemResponse></GetListingItemResponse>Корневой узел XML-документа ответа

<GetListingItemHeader></GetListingItemHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<GetListingsItemContent></GetListingsItemContent>Содержание списка

<Listing></Listing>Содержание перечисления элементов

<ListingId></ListingId>Идентификатор списка

<Domain></Domain>Доменное имя

<Price></Price>Цена

<InBoundLinks></InBoundLinks>Количество входящих ссылок

<Age></Age>Возраст

Get Listing Item Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name

Response (JSON format)

{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No"
    }
  }
}

Команда Купить Сейчас

Support multi-thread

При вызове команды buy it now, следующие параметры должны быть включены:

Параметр запроса «Купить сейчас»Пояснение

Параметр запроса «Купить сейчас»
Пояснение

domainДомен, который вы хотите купить, может быть введен только один 1 домен на запрос

currency (необязательно)Валюта результата возврата должна быть "usd", "eur", или "cny",, если не указана валюта, будет применяться валюта по умолчанию для учетной записи

XML-тег результатаПояснение

XML-тег результата
Пояснение

<BuyItNowResponse></BuyItNowResponse>Корневой узел XML-документа ответа

<BuyItNowHeader></BuyItNowHeader>Заголовок ответа

<SuccessCode></SuccessCode>Успешность выполнения операции: "0" при успехе, "-1" при неудаче

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке, используется при статусе "error"

<Message></Message>Должно быть "заказ домена создан", используется только при успешном статусе.

Пример покупки сейчас

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=currency

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
</BuyItNowResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=currency

Response (JSON format)

{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}

Команда "Установить на продажу"

Support multi-thread

Эта команда поддерживает многопоточность.

Вызов команды Set For Sale добавит ваш домен на продажу на Доменной бирже. Эта команда доступна только в форматах XML и JSON. При вызове этой команды следует включить следующие параметры:

Установить параметр запроса на продажуПояснение

Установить параметр запроса на продажу
Пояснение

domainsВы хотите разместить свой домен на продажу на доменном рынке. В каждом запросе можно указать только 1 домен.

for_sale_typeВы можете выбрать значение из следующего списка, чтобы представить ваш тип продажи:
> маркетплейс:
Разместите свой домен на продажу в Доменном маркетплейсе. Новые списки доменов будут отнесены к указанной категории, подкатегории и цене. Если установлена фактическая цена, домен будет доступен для моментальной покупки и передачи покупателю. Более подробная информация о процессе продажи доменов >

> not_for_sale:
отменить список

listing_type (optional)У вас есть возможность выбрать значение из следующего списка, чтобы представить ваш тип продаж через рынок: (обязательно, если for_sale_type - это рынок)
> купить сейчас
Установка фиксированной цены сделает домен доступным для мгновенной покупки и передачи покупателю.
Примечание: Для домена в период отвода, при его продаже он может больше не быть удален по отводу. Дополнительная информация о удалении по отводу

> сделать предложение
Вы можете выбрать минимальную цену предложения или оставить ее пустой, чтобы разрешить любую сумму предложения.
Примечание: Для домена в периоде отвода, при его продаже он может больше не быть удален по отводу. Дополнительная информация о удалении по отводу

> купить сейчас и сделать предложение Установка фиксированной цены сделает домен доступным для мгновенной покупки и передачи покупателю.
Вы можете выбрать минимальную цену предложения или оставить ее пустой, чтобы разрешить любую сумму предложения.
Примечание: Для домена в периоде отвода, при его продаже он может больше не быть удален по отводу. Дополнительная информация о удалении по отводу

price (optional)цена, по которой вы хотите продать свой домен. (обязательно, если тип продажи - рынок)

minimum_offer (optional)минимальное предложение, которое вы готовы принять за ваш домен. (обязательно, если тип продажи - рынок)

installment (optional)Разрешены ли рассроченные платежи. Если вы хотите разрешить рассроченные платежи, установите их равными к "Да"

maximum_installments (optional)Максимальное количество разрешенных выплат Используется только, когда выплата является "true" Вы можете выбрать значение от 2 до 12 для представления максимального количества месяцев для выплаты в рассрочку

category (optional)выберите категорию для вашего домена, вы можете обратиться к таблице сравнения категорий и подкатегорий ниже для необязательного заполнения.

Sub-category (optional)выберите подкатегорию для вашего домена, Вы можете обратиться к таблице сравнения категорий и подкатегорий ниже для выбора.

Description (optional)Описание вашего домена

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetForSaleResponse></SetForSaleResponse>Корневой узел ответа

<SetForSaleHeader></SetForSaleHeader>Установить заголовок Продается

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

Пример установки на продажу

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription

Response (JSON format)

{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}

Установить команду подтверждения Afternic

Support multi-thread

Вызов команды Set Afternic Confirm Action установит домен для одобрения или отклонения передачи на Afternic. Эта команда доступна только в форматах XML и JSON. При вызове этой команды следует включить следующие параметры:

Установить параметр запроса подтверждения действия AfternicПояснение

Установить параметр запроса подтверждения действия Afternic
Пояснение

domainДомен, который вы хотите установить, Afternic подтвердит действие быстрого перевода, только 1 домен может быть введен за запрос.

actionДействие, которое вы хотите установить для подтверждения Afternic, должно быть "confirm_afternic", или "delete_from_afternic"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Метка Set Afternic Confirm Action Response, это корневой узел ответа XML документа.

<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Настроить заголовок действия подтверждения Afternic

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

Set Afternic Confirm Action Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic

Response (JSON format)

{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}

Установить команду подтверждения действия Sedo

Support multi-thread

Вызов команды Set Sedo Confirm Action установит домен для одобрения или отклонения быстрого переноса на Sedo. Эта команда доступна только в форматах XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Установить параметр запроса подтверждения действия SedoПояснение

Установить параметр запроса подтверждения действия Sedo
Пояснение

domainДомен, который вы хотите установить, Sedo подтверждает действие быстрого переноса, можно ввести только 1 домен за запрос.

actionДействие, которое вы хотите установить на седо, должно быть "confirm_sedo", или "delete_from_sedo".

XML-тег результатаПояснение

XML-тег результата
Пояснение

<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Метка ответа на подтверждение действия Set Sedo, это корневой узел документа ответа XML

<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>Установить заголовок действия подтверждения Sedo

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

Set Sedo Confirm Action Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo

Response (JSON format)

{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}

Команда списка заказов

Support multi-thread

Вызов команды «Список заказов» вернет список заказов. Эта команда доступна только в форматах XML и JSON. Если вызывается эта команда, следующие параметры должны быть включены.

Параметр запроса списка заказовПояснение

Параметр запроса списка заказов
Пояснение

search_byВы можете выбрать значение из следующего списка, чтобы представить ваш тип поиска: date_range, domain, order_id

start_dateдата начала вашего запроса в формате yyyy/MM/dd

end_dateдата окончания вашего запроса в формате гггг/ММ/дд

payment_methodВы можете выбрать несколько значений из следующего списка для представления вашего способа оплаты: none_balance account_balance credit_card money_order paypal moneybookers bank_wire alipay payflow_credit_card2 (Больше не используется) wechat_pay ecash bank_transfer apple_pay checking_account sale union_pay paypal_account mercado_pago payoneer но, пожалуйста, используйте запятую для разделения нескольких значений, например: account_balance,credit_card.

XML-тег результатаПояснение

XML-тег результата
Пояснение

<OrderListResponse></OrderListResponse>Корневой узел ответа

<OrderListHeader></OrderListHeader>Заголовок списка заказов

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

<OrderListContent></OrderListContent>Заголовок списка заказов

<OrderList></OrderList>Содержит несколько наборов данных журнала заказов

<OrderItem></OrderItem>Содержит данные единичного ордер-лога

<OrderItemDomain></OrderItemDomain>Доменное имя, которое включает элементы в этом порядке

<OrderId></OrderId>Содержит идентификатор заказа

<SubmittedDate></SubmittedDate>Содержит дату подачи заказа

<Cost></Cost>Содержит стоимость заказа

<Status></Status>Содержит статус заказа

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

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1734831656189</SubmittedDate>
        <Currency>USD</Currency>
        <PaymentMethod>Account Balance</PaymentMethod>
        <TotalCost>$8.00</TotalCost>
        <TotalPaid>$8.00</TotalPaid>
        <Status>Problem</Status>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test.com</Name>
          <Duration>1</Duration>
          <Cost>2.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test1.ac</Name>
          <Duration>1</Duration>
          <Cost>3.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test2.de</Name>
          <Duration>1</Duration>
          <Cost>4.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test3.gg</Name>
          <Duration>1</Duration>
          <Cost>5.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test4.uk</Name>
          <Duration>1</Duration>
          <Cost>6.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test5.net</Name>
          <Duration>1</Duration>
          <Cost>7.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
      </Order>
      <Order>
        <OrderId>123457</OrderId>
        <SubmittedDate>1734831656189</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card

Response (JSON format)

{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2024/12/21",
        "Currency": "USD",
        "PaymentMethod": "Account Balance",
        "TotalCost": "$8.00",
        "TotalPaid": "$8.00",
        "Status": "Problem",
        "ItemList": [
          {
            "ItemType": "Domain Registration",
            "Name": "test.com",
            "Duration": 1,
            "Cost": "2.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test1.ac",
            "Duration": 1,
            "Cost": "3.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test2.de",
            "Duration": 1,
            "Cost": "4.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Registration",
            "Name": "test3.gg",
            "Duration": 1,
            "Cost": "5.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test4.uk",
            "Duration": 1,
            "Cost": "6.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test5.net",
            "Duration": 1,
            "Cost": "7.99",
            "Status": "Completed"
          }
        ]
      },
      {
        "OrderId": "123457",
        "SubmittedDate": "2024/12/21",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}

Команда для получения статуса заказа

Support multi-thread

Вызов команды Get Order Status приведет к получению состояния заказа. Эта команда доступна только в форматах XML и JSON. Если вы вызываете эту команду, следующие параметры должны быть включены:

Получить параметр запроса статуса заказаПояснение

Получить параметр запроса статуса заказа
Пояснение

order_idID заказа для запроса

XML-тег результатаПояснение

XML-тег результата
Пояснение

<GetOrderStatusResponse></GetOrderStatusResponse>Корневой узел ответа

<GetOrderStatusHeader></GetOrderStatusHeader>Получить заголовок статуса заказа

<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

<GetOrderStatusContent></GetOrderStatusContent>содержание ответа

<OrderId></OrderId>номер заказа

<OrderStatus></OrderStatus>статус заказа (покупка, отправлено, ожидает оплату, обрабатывается, завершено, проблема, удалено, отменено)

<ItemTypeName></ItemTypeName>Тип предмета

<ItemName></ItemName>Наименование товара

<ItemStatus></ItemStatus>Статус товара (Завершен, Отменен, Проблема)

Get Order Status Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0

Response (JSON format)

{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}

Команда Is Processing

Support multi-thread

Вызов команды is_processing сообщит вам, можно ли отправить новый запрос

Параметр запроса is-processingПояснение

Параметр запроса is-processing
Пояснение

дополнительных параметров не требуется

XML-тег результатаПояснение

XML-тег результата
Пояснение

<Response></Response>Тег ответа is_processing

<ResponseHeader></ResponseHeader>Тег заголовка is_processing

<ResponseMsg></ResponseMsg>Тег сообщения ответа is_processing. Должен быть «yes» (В системе запущен процесс. Не следует отправлять еще один запрос.) или «no» (Нет процессов для вашей учетной записи. Можно отправить новый запрос.)

Is-Processing Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing

Response (XML format)

<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing

Response (JSON format)

{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}

Request Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing

Response Запретить все звездочки, знаки, символы, HTML-теги, '%' быть переведенными.

ok,yes

Команда списка купонов

Support multi-thread

Вызов команды List Coupons получит все купоны. Эта команда доступна только в формате XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Параметр запроса списка купоновПояснение

Параметр запроса списка купонов
Пояснение

coupon_typeВы можете выбрать значение из следующего списка, чтобы представить ваш тип поиска: "registration" , "renewal" , или "transfer"

XML-тег результатаПояснение

XML-тег результата
Пояснение

<ListCouponsResponse></ListCouponsResponse>Корневой узел ответа

<ListCouponsHeader></ListCouponsHeader>Список купонов

<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" для успеха, "-1" для ошибки

<Status></Status>Статус запроса

<Error></Error>Информация об ошибке по запросу, используется только при статусе "ошибка"

<ListCouponsContent></ListCouponsContent>Список купонов содержимого

<Coupons></Coupons>Содержит несколько наборов данных купонов

<Coupon></Coupon>Содержит данные одного купона

<Code></Code>Код купона

<Description></Description>Описание купона

<CouponType></CouponType>Тип купона

<DiscountType></DiscountType>Тип скидки, предлагаемой купоном

<DiscountInfo></DiscountInfo>Информация о скидке купона

<Percentage></Percentage>Процент скидки

<AUD></AUD>Сумма скидки в австралийских долларах

<MXN></MXN>Сумма скидки в мексиканских песо

<EUR></EUR>Сумма скидки в евро

<GBP></GBP>Сумма скидки в британских фунтах

<IDR></IDR>Сумма скидки в индонезийских рупиях

<USD></USD>Сумма скидки в долларах США

<CAD></CAD>Сумма скидки в канадских долларах

<INR></INR>Сумма скидки в индийских рупиях

<BRL></BRL>Сумма скидки в бразильских реалах

<CNY></CNY>Сумма скидки в китайских юанях

<Restriction></Restriction>Ограничения купонов

<PriceLevels></PriceLevels>Собрание уровней цен, которые поддерживают использование купонов

<UsesPerAccount></UsesPerAccount>Количество раз, когда купон может быть использован на один аккаунт

<UsesSystemWide></UsesSystemWide>Количество раз, когда купон может быть использован по всей системе

<UsesPerIp></UsesPerIp>Количество раз, когда купон может быть использован с одного IP-адреса

<ItemsPerAccount></ItemsPerAccount>Количество товаров, на которые можно использовать купон, на один аккаунт

<ItemsSystemWide></ItemsSystemWide>Количество товаров, на которые купон может быть использован по всей системе

<ItemsPerOrder></ItemsPerOrder>Количество товаров, на которые можно использовать купон за заказ

<ItemsPerDay></ItemsPerDay>Количество товаров, на которые можно использовать купон в день

<IdnRestriction></IdnRestriction>Ограничения IDN для купона

<DomainDurationMin></DomainDurationMin>Минимальная продолжительность домена

<DomainDurationMax></DomainDurationMax>Максимальная продолжительность домена

<Tlds></Tlds>Коллекция доменов верхнего уровня, которые поддерживают использование купонов

<Tld></Tld>Единственный домен верхнего уровня, который поддерживает использование купонов

<Currencies></Currencies>Коллекция типов валют, которые поддерживают использование купонов

<Currency></Currency>Единый тип валюты, который поддерживает использование купонов

<StartDate></StartDate>Дата начала действия купона

<EndDate></EndDate>Дата окончания действия купона

Список купонов Пример

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=list_coupons&coupon_type=renewal

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ListCouponsResponse>
  <ListCouponsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </ListCouponsHeader>
  <ListCouponsContent>
    <Coupons>
      <Coupon>
        <Code>DOMAINRENEW1</Code>
        <Description>Domain Renew Coupon</Description>
        <CouponType>Hosting/SSL Coupons</CouponType>
        <DiscountType>PERCENTAGE_OFF</DiscountType>
        <DiscountInfo>
          <Percentage>10%</Percentage>
        </DiscountInfo>
        <Restriction>
          <PriceLevels>Any</PriceLevels>
          <IdnRestriction>None</IdnRestriction>
          <DomainDurationMin>1</DomainDurationMin>
          <DomainDurationMax>1</DomainDurationMax>
          <Tlds>
            <Tld>.com</Tld>
            <Tld>.net</Tld>
            <Tld>.org</Tld>
          </Tlds>
          <Currencies>
            <Currency>US Dollar USD ($)</Currency>
          </Currencies>
        </Restriction>
        <StartDate>1476811260000</StartDate>
        <EndDate>1483257540000</EndDate>
      </Coupon>
    </Coupons>
  </ListCouponsContent>
</ListCouponsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=list_coupons&coupon_type=renewal

Response (JSON format)

{
  "ListCouponsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Coupons": [
      {
        "Code": "DOMAINRENEW1",
        "Description": "Domain Renew Coupon",
        "CouponType": "Hosting/SSL Coupons",
        "DiscountType": "PERCENTAGE_OFF",
        "DiscountInfo": {
          "Percentage": "10%"
        },
        "Restriction": {
          "PriceLevels": "Any",
          "IdnRestriction": "None",
          "DomainDurationMin": "1",
          "DomainDurationMax": "1",
          "Tlds": [
            ".com",
            ".net",
            ".org"
          ],
          "Currencies": [
            "US Dollar USD ($)"
          ]
        },
        "StartDate": "1476811260000",
        "EndDate": "1483257540000"
      }
    ]
  }
}

Chat Online

Текущие чаты в очереди:0

Чат в Интернете0