Домены

Список команд API для доменов

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

Начало работы с нашим Advanced Domain API

Устаревший API, запланировано отключение. Вместо него используйте наш RESTful API:

https://www.dynadot.com/domain/api-document

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

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

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

Вы будете получать разное количество потоков в зависимости от уровня расходов вашего аккаунта:

Уровень расходовКоличество потоковЛимит скорости
Обычный1 поток60/мин (1/сек)
Опт5 потоков600/мин (10/сек)
супер-опт35 потоков6000/мин (100/сек)

 
Параметр запроса
Пояснение
KeyВаш ключ для доступа к API, доступен в панели управления вашего аккаунта Dynadot в боковом меню 'Tools' -> 'API'.
Command
Домен:
search, register, delete, renew, push, transfer, bulk_register, restore

domain_info, set_whois, set_ns, set_parking, set_forwarding, set_stealth, set_hosting, set_dns2, set_email_forward, set_clear_domain_setting, set_folder, set_note, set_renew_option, set_privacy, tld_price, list_domain, lock_domain, suggestion_search, set_dnssec, get_dnssec, clear_dnssec

cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_domain_push_request, set_domain_push_request
контакт:
create_cn_audit, get_cn_audit_status, create_contact, edit_contact, delete_contact, contact_list, get_contact

set_contact_eu_setting, set_contact_lv_setting, set_contact_lt_setting
Сервер имен:
get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns
Аккаунт:
account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, set_default_email_forward, set_clear_default_setting, set_default_renew_option
Папка:
create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_dns2, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list
Вторичный рынок:
add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, get_auction_bids, place_auction_bid, get_closed_auctions

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions, get_expired_closeout_domains, buy_expired_closeout_domain, get_listings, get_listing_item, buy_it_now, add_new_lead
Другое:
set_afternic_confirm_action, set_sedo_confirm_action, get_whois_stats, order_list, set_for_sale, get_order_status, is_processing, transfer_out_domain_list, list_coupons, download_all_listings

Формат XML. Ответ, который вы получите, должен содержать 2 или 3 из следующих полей:

XML-тег результата
Пояснение
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр поискового запроса
Пояснение
domain0 - domain99Имя домена, которое вы ищете; обычный аккаунт может указать 1 домен на команду, аккаунты bulk и super bulk могут указать до 100 доменов
language0 - language99 (optional)Языковой тег для соответствующего домена, используйте только для IDN
show_price (optional)Если вы хотите показывать цену в валюте вашего аккаунта, установите значение "1". Если домен доступен, будут отображены сведения о премиум-статусе и информация о цене.
currency (optional)Вы можете выбрать тип валюты; поддерживаются следующие значения параметра: "USD","CNY", "GBP","EUR","INR","CAD" и так далее. Если вы пропустите этот параметр, мы будем использовать валюту аккаунта по умолчанию.
XML-тег результата
Пояснение
<Results></Results>Корневой узел XML-ответа команды поиска
<SearchResponse></SearchResponse>Тег ответа поиска
<SearchHeader></SearchHeader>Тег заголовка поиска
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<DomainName></DomainName>Доменное имя, которое вы только что искали
<Available></Available>Если доменное имя доступно
<Price></Price>Если вы установите "show_price" в "1", это сообщит вам информацию о цене, если этот домен доступен.
<Language></Language>Языковая информация о доменном имени

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Ответ (формат XML)
<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 and domain is not premium</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Ответ (формат JSON)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на регистрацию
Пояснение
domainДоменное имя, которое вы хотите зарегистрировать, за один запрос можно зарегистрировать только 1 домен
language (optional)Языковой тег для запрашиваемого домена, требуется только если домен является IDN
durationНа какой срок зарегистрировать домен
registrant_contact (optional)Контакт регистранта, который вы хотите использовать для домена
admin_contact (optional)Контакт администратора, который вы хотите использовать для домена
technical_contact (optional)Технический контакт, который вы хотите использовать для домена
billing_contact (optional)Контакт для оплаты, который вы хотите использовать для домена
option0 (if necessary)
Имя регистранта для .AT, .BE
option1 (if necessary)Организация регистранта для .AT, .BE (необязательно)
Для .AT вы можете указать либо option0, либо option1, либо и то, и другое
premium (optional)Если вы хотите зарегистрировать премиум-домен, установите его равным "1" (необязательно)
currency (optional)Вы можете выбрать тип валюты; поддерживаются следующие значения параметра: "USD","CNY", "GBP","EUR","INR","CAD" и так далее. Если вы пропустите этот параметр, мы будем использовать валюту аккаунта по умолчанию.
coupon (optional)Промокод, который вы хотите применить к этой команде
XML-тег результата
Пояснение
<RegisterResponse></RegisterResponse>Тег ответа регистрации
<RegisterHeader></RegisterHeader>Тег заголовка регистрации
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<RegisterContent></RegisterContent>Тег содержимого регистрации
<Expiration></Expiration>Дата истечения срока в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года), используется только когда результат "success"
<Registration></Registration>Дата регистрации в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года), используется только если result — "success"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Ответ (формат JSON)
{
  "RegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.net",
    "Expiration": 1458379145266
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса удаления
Пояснение
domainДоменное имя, которое вы хотите удалить, за один запрос можно удалить только 1 домен
XML-тег результата
Пояснение
<DeleteResponse></DeleteResponse>Тег ответа на удаление
<DeleteHeader></DeleteHeader>Тег заголовка удаления
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete&domain=domain1.com
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete&domain=domain1.com
Ответ (формат JSON)
{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса продления
Пояснение
domainДоменное имя, которое вы хотите продлить, за один запрос можно продлить только 1 домен
durationНа сколько лет продлить домен
year (optional)Текущий год истечения срока действия домена
currency (optional)Вы можете выбрать тип валюты; поддерживаются следующие значения параметра: "USD","CNY", "GBP","EUR","INR","CAD" и так далее. Если вы пропустите этот параметр, мы будем использовать валюту аккаунта по умолчанию.
price_check (optional)Вы можете добавить этот параметр к команде, чтобы проверить детали цены за продление этого домена. ПРИМЕЧАНИЕ: Если добавить этот параметр к команде, наш API не продлит домен, а только покажет информацию о цене.
coupon (optional)Промокод, который вы хотите применить к этой команде
no_renew_if_late_renew_fee_needed (optional)Вы можете добавить этот параметр в команду, чтобы избежать продления, если для домена требуется плата за позднее продление. Если для продления домена действительно требуется плата за позднее продление, и в команде передан "no_renew_if_late_renew_fee_needed = 1", домен не будет продлён.
XML-тег результата
Пояснение
<RenewResponse></RenewResponse>Тег ответа на продление, это корневой узел XML-документа ответа
<RenewHeader></RenewHeader>Заголовок продления
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<PriceInfo></PriceInfo>Тег информации о цене, используется только когда статус равен "price_check_success"
<RenewContent></RenewContent>Тег содержимого продления, используется только когда статус равен "success"
<Expiration></Expiration>Дата истечения срока в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года), используется только когда результат "success"

Пример продления

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Ответ (формат XML)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Ответ (формат JSON)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}
 

Команда push

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса Push
Пояснение
domainДоменное имя, которое вы хотите передать. Мы также поддерживаем массовую передачу; вы можете разделять домены с помощью ";". Пример: domain1.com;domain2.com
receiver_push_usernamePush-имя пользователя аккаунта получателя
currency (optional)Вы можете выбрать тип валюты; поддерживаются следующие значения параметра: "USD","CNY", "GBP","EUR","INR","CAD" и так далее. Если вы пропустите этот параметр, мы будем использовать валюту аккаунта по умолчанию.
unlock_domain_for_push(optional)Установите этот параметр равным "1". Если домен заблокирован, мы автоматически разблокируем его, так что вам не нужно вручную разблокировать домен.
receiver_email(optional)Email аккаунта получателя для push
XML-тег результата
Пояснение
<PushResponse></PushResponse>Тег push-ответа, это корневой узел XML-документа ответа
<PushHeader></PushHeader>Заголовок Push
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример Push

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Ответ (формат XML)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Ответ (формат JSON)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

Команда переноса

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса переноса
Пояснение
domainДоменное имя, которое вы хотите перенести в Dynadot, за один запрос можно перенести только 1 домен
authКод авторизации для запроса на перенос.
currency (optional)Вы можете выбрать тип валюты; поддерживаются следующие значения параметра: "USD","CNY", "GBP","EUR","INR","CAD" и так далее. Если вы пропустите этот параметр, мы будем использовать валюту аккаунта по умолчанию.
registrant_contact (optional)Контакт регистранта, который вы хотите использовать после завершения переноса. (Не все TLD поддерживают эту функцию)
admin_contact (optional)Контакт администратора, который вы хотите использовать при завершении переноса. (Не все TLD поддерживают эту функцию)
technical_contact (optional)Технический контакт, который вы хотите использовать после завершения переноса. (Не все TLD поддерживают эту функцию)
billing_contact (optional)Контакт для выставления счетов, который вы хотите использовать при завершении переноса. (Не все домены верхнего уровня поддерживают эту функцию)
premium (optional)Если вы хотите перенести премиум-домен, установите значение "1" (необязательно)
privacy (optional)Статус приватности домена, который вы хотите установить; может быть "on" или "off". Если указано неверно или не указано, будет применён уровень приватности по умолчанию для аккаунта.
name_servers (optional)Список серверов имен, которые нужно применить к домену после завершения переноса. Вы можете использовать "," для разделения серверов имен. Пример: ns1.domain1.com,ns2.domain2.com
coupon (optional)Промокод, который вы хотите применить к этой команде
XML-тег результата
Пояснение
<TransferResponse></TransferResponse>Тег ответа на трансфер; это корневой узел XML-документа ответа
<TransferHeader></TransferHeader>Заголовок трансфера
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример трансфера

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Ответ (формат JSON)
{
  "TransferResponse": {
    "ResponseCode": 0,
    "Status": "order created",
    "DomainName": "domain1.com",
    "OrderId": "1234567"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса массовой регистрации
Пояснение
domain0-domain99Доменное имя (имена), которые вы хотите зарегистрировать, максимум 100 доменов можно зарегистрировать за один запрос
premium (optional)Если вы хотите зарегистрировать премиум-домен, установите его равным "1" (необязательно)
currency (optional)Вы можете выбрать тип валюты; поддерживаются такие значения параметра: "USD","CNY", "GBP","EUR","INR","CAD" и так далее. Если вы пропустили этот параметр, мы будем использовать валюту по умолчанию для аккаунта.
coupon (optional)Промокод, который вы хотите применить к этой команде
XML-тег результата
Пояснение
<BulkRegisterResponse></BulkRegisterResponse>Тег ответа массовой регистрации
<BulkRegisterHeader></BulkRegisterHeader>Тег заголовка массовой регистрации
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<BulkRegisterContent></BulkRegisterContent>Тег содержимого массовой регистрации
<Expiration></Expiration>Дата истечения срока в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года), используется только когда результат "success"
<Result></Result>Результат действия регистрации
<Message></Message>Сообщение об ошибке операции регистрации, используется только когда результат — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Ответ (формат JSON)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

Команда информации о домене

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса информации о домене
Пояснение
domainЗа один запрос допускается только 1 домен
XML-тег результата
Пояснение
<DomainInfoResponse></DomainInfoResponse>Корневой узел XML-документа ответа
<DomainInfoResponseHeader></DomainInfoResponseHeader>Заголовок ответа
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<DomainInfoContent></DomainInfoContent>Содержимое ответа
<Domain></Domain>Домен
<Name></Name>Имя домена
<Expiration></Expiration>Дата истечения срока действия домена в формате Unix time (миллисекунды с полуночи 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 заблокирован или нет
<UdrpLocked></UdrpLocked>UDRP заблокирован или нет
<RegistrantUnverified></RegistrantUnverified>Регистрант не подтверждён
<Hold></Hold>Статус удержания клиента/регистратора
<Privacy></Privacy>Статус приватности
<isForSale></isForSale>Статус продажи
<RenewOption></RenewOption>Опция продления
<Note></Note>Примечание
<Folder></Folder>Информация о папке
<FolderId></FolderId>ID папки
<FolderName></FolderName>Имя папки

Пример информации о домене

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
Ответ (формат XML)
<?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>
      <Status>active</Status>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
Ответ (формат JSON)
{
  "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)"
      },
      "Status": "active"
    }
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса Whois
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
registrant_contactИнформация о регистранте домена
admin_contactИнформация об администраторе домена
technical_contactТехническая информация о домене
billing_contactПлатёжная информация домена
XML-тег результата
Пояснение
<SetWhoisResponse></SetWhoisResponse>Корневой узел XML-документа ответа
<SetWhoisHeader></SetWhoisHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки Whois

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Ответ (формат XML)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Ответ (формат JSON)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на установку серверов имен
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
ns0 - ns12NS-серверы, которые нужно назначить для вашего домена; можно указать до 13 NS-серверов, но они уже должны быть в вашем аккаунте.
XML-тег результата
Пояснение
<SetNsResponse></SetNsResponse>Тег ответа set name server, это корневой узел XML-документа ответа
<SetNsHeader></SetNsHeader>Тег заголовка ответа установки сервера имён
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Ответ (формат JSON)
{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки парковки
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
with_ads (optional)Если вы не хотите сторонней рекламы, вы можете использовать этот параметр со значением "no"
XML-тег результата
Пояснение
<SetParkingResponse></SetParkingResponse>Тег ответа на команду установки парковки, это корневой узел XML-документа ответа
<SetParkingHeader></SetParkingHeader>Заголовок папки парковки
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки парковки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
Ответ (формат XML)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
Ответ (формат JSON)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки переадресации
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
forward_urlURL-адрес, на который вы хотите перенаправлять ваш домен. Обратите внимание, что параметр должен быть закодировано чтобы вызов API был интерпретирован правильно.
is_temp (optional)Желаемый статус переадресации вашего домена, значение по умолчанию — "temporary". Если вы хотите переадресовывать навсегда, используйте этот параметр со значением "no"
XML-тег результата
Пояснение
<SetForwardingResponse></SetForwardingResponse>Корневой узел XML-документа ответа
<SetForwardingHeader></SetForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки переадресации

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Ответ (формат XML)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Ответ (формат JSON)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Установить скрытую команду

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр скрытого запроса
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
stealth_urlURL-адрес, на который вы хотите перенаправлять ваш домен. Обратите внимание, что параметр должен быть закодировано чтобы вызов API был интерпретирован правильно.
stealth_title (optional)Заголовок страницы
XML-тег результата
Пояснение
<SetStealthResponse></SetStealthResponse>Корневой узел XML-документа ответа
<SetStealthHeader></SetStealthHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки Stealth

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Ответ (формат XML)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Ответ (формат JSON)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда Set Hosting

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки хостинга
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
hosting_typeТип хостинга, который вы хотите, можно выбрать из "advanced" и "basic"
mobile_view_onТолько когда hosting_type имеет значение "advanced", вы можете использовать этот параметр со значением "yes".
XML-тег результата
Пояснение
<SetHostingResponse></SetHostingResponse>Корневой узел XML-документа ответа
<SetHostingHeader></SetHostingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки хостинга

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Ответ (формат XML)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Ответ (формат JSON)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда настройки DNS2

Поддержка многопоточности
Поддержка API Sandbox

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

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

Установить параметр запроса DNS2
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
main_record_type0 - main_record_type19 (optional)Основной тип записи, должен быть "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Укажите DNS-запись для вашего домена
main_recordx0 - main_recordx19Mx-расстояние, тип переадресации (301 как "1", 302 как "2"), заголовок скрытой переадресации или псевдоним электронной почты; необходимо, когда main_record_type равен "forward","mx","stealth","email".
subdomain0 - subdomain99 (optional)Записи поддомена (необязательно)
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 (optional)Время жизни
add_dns_to_current_setting (optional)Если вы хотите добавить новые настройки DNS к существующим настройкам DNS. Установите значение "1" (необязательно)
XML-тег результата
Пояснение
<SetDnsResponse></SetDnsResponse>Корневой узел XML-документа ответа
<SetDnsHeader></SetDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки DNS2

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
Ответ (формат JSON)
{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

Вызов команды Set Dnssec установит DNSSEC для домена. Эта команда доступна только в формате XML и JSON. Если вызывать эту команду, нужно указать следующие параметры:

Вы можете заполнить соответствующие значения параметров в поле Option в зависимости от вашего доменного имени.

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

Вариант 2 : domain_name , flags , public_key , algorithm

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

Параметр запроса Set 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-тег результата
Пояснение
<SetDnssecResponse></SetDnssecResponse>корневой узел ответа
<SetDnssecHeader></SetDnssecHeader>Установить заголовок DNSSEC
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnssecResponse>
  <SetDnssecHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnssecHeader>
  <SetDnssecContent/>
</SetDnssecResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Ответ (формат JSON)
{
  "SetDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Команда очистки Dnssec

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса очистки Dnssec
Пояснение
domain_nameДоменное имя, для которого нужно очистить DNSSEC

Пример очистки Dnssec

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<ClearDnssecResponse>
  <ClearDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ClearDnssecHeader>
</ClearDnssecResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Ответ (формат JSON)
{
  "ClearDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Команда настройки пересылки электронной почты

Поддержка многопоточности
Поддержка API Sandbox

При вызове команды set email forward следует включить следующие параметры:

Параметр запроса на настройку пересылки email
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
forward_typeТип переадресации. Может быть "donot": не пересылать email, "mx": доставлять email на другой почтовый хост (MX-запись), "forward": доставлять 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-тег результата
Пояснение
<SetEmailForwardingResponse></SetEmailForwardingResponse>Корневой узел XML-документа ответа
<SetEmailForwardingHeader></SetEmailForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки пересылки email

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Ответ (формат XML)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Ответ (формат JSON)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки очистки домена
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
serviceСервис, который вы хотите очистить, может быть "forward", "stealth", "email_forwarding", "dns", "dnssec" и "nameservers"
XML-тег результата
Пояснение
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Корневой узел XML-документа ответа
<SetClearDomainSettingHeader></SetClearDomainSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки Clear Domain Setting

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Ответ (формат XML)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Ответ (формат JSON)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки папки
Пояснение
domainДоменное имя для обновления, в одном запросе можно указать только 1 домен
folderИмя папки, в которую вы хотите переместить домен. Используйте "Default" в качестве имени папки, если хотите переместить домен в папку по умолчанию. Имя папки чувствительно к регистру. Например, "Folder1" и "folder1" — это два разных имени папки.
folder_id (optional)ID папки, в которую вы хотите переместить ваш домен
XML-тег результата
Пояснение
<SetFolderResponse></SetFolderResponse>Тег ответа set folder — это корневой узел XML-документа ответа
<SetFolderHeader></SetFolderHeader>Установить заголовок папки
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки папки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
Ответ (формат XML)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
Ответ (формат JSON)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

Если вызываете команду set note, следует указать следующие параметры:

Параметр запроса настройки примечания
Пояснение
domainДомен, который вы хотите установить, за один запрос можно установить только 1 домен
noteПримечание, которое вы хотите установить для домена, может быть null
XML-тег результата
Пояснение
<SetNoteResponse></SetNoteResponse>Корневой узел XML-документа ответа
<SetNoteHeader></SetNoteHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки заметки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Ответ (формат XML)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Ответ (формат JSON)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Настроить опцию продления

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса опции продления
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
renew_optionМожет быть "donot", "auto", "reset"
XML-тег результата
Пояснение
<SetRenewOptionResponse></SetRenewOptionResponse>Корневой узел XML-документа ответа
<SetRenewOptionHeader></SetRenewOptionHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки опции продления

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Ответ (формат JSON)
{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки приватности
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
optionСтатус приватности домена, который вы хотите установить; может быть "full", "partial" или "off"
whois_privacy_optionСтатус приватности whois для домена, который вы хотите настроить, может быть "yes" или "no"
XML-тег результата
Пояснение
<SetPrivacyResponse></SetPrivacyResponse>Корневой узел XML-документа ответа
<SetPrivacyHeader></SetPrivacyHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки приватности

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Ответ (формат XML)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Ответ (формат JSON)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Цены на TLD

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса цен на TLD
Пояснение
currency (optional)Валюта возвращаемого результата должна быть "usd", "eur" или "cny", валюта по умолчанию — Api Default Currency из настроек аккаунта
count_per_page (optional)Сколько сущностей отображается на странице
page_index (optional)Сущности какой страницы вы хотите просмотреть
sort (optional)Выберите один из следующих вариантов в качестве значения параметра сортировки:
* Если вы его не выбрали, мы будем использовать сортировку по умолчанию.
1) RankAsc (По умолчанию)
2) RankDesc
3) Имя по возрастанию
4) Имя по убыванию
5) SalesAsc
6) SalesDesc
7) LaunchDateAsc
8) Описание даты запуска
9) CountAsc
10) CountDesc
11) RegistryAsc
12) Описание реестра
XML-тег результата
Пояснение
<TldPriceResponse></TldPriceResponse>Корневой узел XML-документа ответа
<TldPriceResponseHeader></TldPriceResponseHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<TldPriceContent></TldPriceContent>Содержимое ответа
<TldContent></TldContent>Информация о TLD
<Tld></Tld>Домены верхнего уровня
<Usage></Usage>Использование TLD
<Price></Price>Информация о цене этого tld. Содержит подтеги: : Единица цены : Цена регистрации : Цена продления : Цена переноса
<Privacy></Privacy>Если этот TLD поддерживает whois privacy
<GracePeriod></GracePeriod>Информация о льготном периоде этого TLD. Содержит подтеги: : Единица данных о льготном периоде : Льготный период продления : Удалить льготный период
<IDN></IDN>Если этот tld поддерживает интернационализированные доменные имена
<Restrictions></Restrictions>Доменное имя

Пример цен на TLD

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=tld_price&currency=USD
Ответ (формат XML)
<?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>
      <OnSale>Yes</OnSale>
      <maxDuration>10</maxDuration>
      <minDuration>1</minDuration>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=tld_price&currency=USD
Ответ (формат JSON)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": "com",
        "Usage": "General",
        "IDN": "YES",
        "Restrictions": "--",
        "OnSale": "Yes",
        "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"
        },
        "maxDuration": 10,
        "minDuration": 1
      }
    ]
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса списка доменов
Пояснение
customer_id (optional)Фильтровать данные по идентификатору клиента (только реселлеры могут использовать этот параметр)
count_per_page (optional)Сколько сущностей отображается на странице
page_index (optional)Сущности какой страницы вы хотите просмотреть
sort (optional)Выберите один из следующих вариантов в качестве значения параметра сортировки:
* Если вы его не выбрали, мы будем использовать сортировку по умолчанию.
1) По возрастанию количества (По умолчанию)
2) CountDesc
3) Имя по возрастанию
4) Имя по убыванию
XML-тег результата
Пояснение
<ListDomainInfoResponse></ListDomainInfoResponse>Корневой узел XML-документа ответа
<ListDomainInfoHeader></ListDomainInfoHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<ListDomainInfoContent></ListDomainInfoContent>Содержимое ответа
<DomainInfoList></DomainInfoList>Список информации о доменах
<DomainInfo></DomainInfo>Информация о домене
<Domain></Domain>Домен
<Name></Name>Доменное имя
<Expiration></Expiration>Дата истечения срока действия домена в формате Unix time (миллисекунды с полуночи 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>Статус включения
<Hold></Hold>Статус удержания клиента/регистратора
<Privacy></Privacy>Статус приватности
<isForSale></isForSale>Статус продажи
<RenewOption></RenewOption>Опция продления
<Note></Note>Примечание
<Folder></Folder>Информация о папке
<FolderId></FolderId>ID папки
<FolderName></FolderName>Имя папки

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_domain
Ответ (формат XML)
<?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>
          <Status>active</Status>
        </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>
          <Status>moved</Status>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_domain
Ответ (формат JSON)
{
  "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)"
        },
        "Status": "active"
      },
      {
        "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)"
        },
        "Status": "moved"
      }
    ]
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

Если вызываете команду lock domain, следует указать следующие параметры:

Параметр запроса блокировки домена
Пояснение
domainДоменное имя, которое вы хотите заблокировать; за один запрос можно ввести только 1 домен
XML-тег результата
Пояснение
<LockDomainResponse></LockDomainResponse>Корневой узел XML-документа ответаXML документ
<LockDomainHeader></LockDomainHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
Ответ (формат XML)
<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
Ответ (формат JSON)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда поиска предложений

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса поиска предложений
Пояснение
domainДомен, который вы хотите найти; за один запрос можно ввести только 1 домен
tlds (optional)Домены верхнего уровня (TLD), которые должны присутствовать в результатах поиска
XML-тег результата
Пояснение
<SuggestionSearchResponse></SuggestionSearchResponse>Тег ответа поиска предложений; это корневой узел XML-документа ответа
<SuggestionSearchHeader></SuggestionSearchHeader>Заголовок поиска предложений
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SuggestionSearchResponse>
  <SuggestionSearchHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SuggestionSearchHeader>
  <SuggestionSearchContent>
    <SuggestionSearch>
      <Domain>test1.com</Domain>
      <Domain>test2.com</Domain>
      <Domain>test3.net</Domain>
      <Domain>test4.net</Domain>
    </SuggestionSearch>
  </SuggestionSearchContent>
</SuggestionSearchResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Ответ (формат JSON)
{
  "SuggestionSearchResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Domains": [
      "test1.com",
      "test2.com",
      "test3.net",
      "test4.net"
    ]
  }
}
 

Команда отмены переноса

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на отмену перевода
Пояснение
domainДоменное имя, для которого вы хотите отменить передачу, за один запрос можно ввести только 1 домен
order_idID заказа на перенос, его можно получить из другого API get_transfer_status.
XML-тег результата
Пояснение
<CancelTransferResponse></CancelTransferResponse>Корневой узел XML-документа ответаXML документ
<CancelTransferHeader></CancelTransferHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
Ответ (формат JSON)
{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на получение статуса переноса
Пояснение
domainДоменное имя, для которого вы хотите получить статус переноса, за один запрос можно указать только 1 домен
transfer_typeТип трансфера, для которого вы хотите получить статус (transfer in или transfer away)
XML-тег результата
Пояснение
<GetTransferStatusResponse></GetTransferStatusResponse>Корневой узел XML-документа ответаXML документ
<GetTransferStatusHeader></GetTransferStatusHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetTransferStatusContent></GetTransferStatusContent>Содержимое ответа
<TransferList></TransferList>Список трансферов
<Transfer></Transfer>Информация о переносе
<OrderId></OrderId>ID заказа
<TransferStatus></TransferStatus>Статус передачи домена. Если вы получили 'none' или 'approved', вы можете отменить передачу. Если вы получили 'waiting', это означает, что передача уже началась. Если вы получили 'auth code needed', это означает неверный код авторизации, вы можете использовать другой API SET_TRANSFER_AUTH для повторной отправки кода авторизации. Также есть некоторые другие статусы, мы отправим вам электронное письмо или они должны быть проверены нашими инженерами.

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Ответ (формат JSON)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки кода авторизации для переноса
Пояснение
domainДоменное имя, для которого вы обновляете код авторизации переноса; за один запрос можно ввести только 1 домен.
auth_codeauth_code, который вы хотите повторно отправить
order_idID заказа на перенос, его можно получить из другого API get_transfer_status.
XML-тег результата
Пояснение
<GetTransferStatusResponse></GetTransferStatusResponse>Корневой узел XML-документа ответаXML документ
<GetTransferStatusHeader></GetTransferStatusHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Ответ (формат XML)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Ответ (формат JSON)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда авторизации передачи домена

Поддержка многопоточности
Поддержка API Sandbox
Параметр запроса на авторизацию Transfer Away
Пояснение
domainДоменное имя, для которого вы хотите разрешить перевод к другому регистратору; в одном запросе можно указать только 1 домен
order_idDynadot order_id домена, который вы хотите перенести
authorizeЧтобы авторизовать перенос, установите значение "approve". Чтобы отклонить перенос, установите значение "deny".
XML-тег результата
Пояснение
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>Корневой узел XML-документа ответаXML документ
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<Result></Result>Результат авторизации перевода домена к другому регистратору

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Ответ (формат JSON)
{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на получение кода авторизации для переноса
Пояснение
domainДоменное имя, для которого хотите получить код авторизации для переноса; за один запрос можно ввести только 1 домен
new_code (optional)Сгенерировать новый код авторизации для переноса
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Если вы хотите разблокировать домен для переноса, установите его равным "1". Если запрос успешно обработан, домен будет разблокирован.
XML-тег результата
Пояснение
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Корневой узел XML-документа ответаXML документ
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<AuthCode></AuthCode>Код авторизации используется для начала передачи домена.

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Ответ (формат JSON)
{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса команды Get Domain Push Request
Пояснение
N/A Дополнительные параметры не нужны
XML-тег результата
Пояснение
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>корневой узел ответа
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>Заголовок запроса на получение push домена
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetDomainPushRequestContent></GetDomainPushRequestContent>содержимое ответа
<PushDomain></PushDomain>Передать домен
<PushDomainName></PushDomainName>Передать доменное имя

Пример запроса на получение Domain Push

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_domain_push_request
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_domain_push_request
Ответ (формат JSON)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса для установки push-запроса домена
Пояснение
domainsДоменное имя заказа, подлежащего обработке
actionДействие заказа, которое нужно обработать, вы можете выбрать "accept" или "decline"
XML-тег результата
Пояснение
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>корневой узел ответа
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>Заголовок запроса на настройку передачи домена
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Ответ (формат JSON)
{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Команда создания CN-аудита

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на создание CN-аудита
Пояснение
contact_idID записи контакта, для которой вы хотите начать аудит, за один запрос можно указать только 1 ID контакта
contact_typeТип контакта, может быть "Individual" или "Enterprise"
individual_id_typeТип идентификатора физического лица, ожидаемые значения (описание значения):
JGZ (удостоверение личности офицера Китайской Народной Республики)
SFZ (удостоверение личности Китайской Народной Республики)
HZ (паспорт)
GAJMTX (Разрешение на выезд и въезд для поездок в Гонконг и Макао)
TWJMTX (проездные документы для жителей Тайваня для въезда на материковую часть Китая или выезда с неё)
WJLSFZ (Удостоверение иностранного постоянного жителя Китайской Народной Республики)
GAJZZ (разрешение на проживание для Гонконга и Макао)
TWJZZ (вид на жительство для жителей Тайваня)
QT (Прочее)
individual_license_idНомер лицензии удостоверения личности физического лица
individual_urlДокумент, удостоверяющий личность физического лица. URL файла на сервере. Разрешены только jpg, gif, png, jpeg
enterprise_id_type (Mandatory when contact type is "Enterprise")Тип Enterprise ID, ожидаемые значения (описание значения):
ORG (Свидетельство о коде организации)
YYZZ (Лицензия на ведение бизнеса)
TYDM (свидетельство о едином коде социального кредита)
BDDM (обозначение военного кода)
JDDWFW (лицензия на платные внешние услуги военного назначения)
SYDWFR (Свидетельство о регистрации юридического лица общественного учреждения)
WGCZJG (Форма регистрации постоянных представительств иностранных предприятий)
SHTTFR (Свидетельство о регистрации юридического лица общественной организации)
ZJCS (Свидетельство о регистрации сайта религиозной деятельности)
MBFQY (Свидетельство о регистрации частной некоммерческой организации)
JJHFR (Свидетельство о регистрации юридического лица фонда)
LSZY (лицензия на практику юридической фирмы)
WGZHWH (Свидетельство о регистрации иностранного культурного центра в Китае)
WLCZJG (Свидетельство о регистрации одобрения постоянного представительства туристических ведомств иностранного правительства)
SFJD (лицензия на судебную экспертизу)
JWJG (Свидетельство иностранной организации)
SHFWJG (Свидетельство о регистрации агентства социального обслуживания)
MBXXBX (Лицензия частной школы)
YLJGZY (Лицензия на осуществление медицинской деятельности)
GZJGZY (Лицензия на осуществление деятельности нотариальной организации)
BJWSXX (разрешение Пекинской школы для детей сотрудников иностранных посольств в Китае)
QTTYDM (Прочее — свидетельство о едином коде социального кредита)
QT (Прочее)
enterprise_license_id (Mandatory when contact type is "Enterprise")Номер лицензии корпоративного документа
enterprise_url (Mandatory when contact type is "Enterprise")Документ лицензии предприятия. URL-адрес файла на сервере. Разрешены только jpg, gif, png, jpeg
XML-тег результата
Пояснение
<CreateCnAuditResponse></CreateCnAuditResponse>Корневой узел XML-документа ответа
<CreateCnAuditHeader></CreateCnAuditHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
Ответ (формат JSON)
{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса получения статуса аудита Cn
Пояснение
contact_idID записи контакта, для которой вы хотите получить статус аудита, за один запрос можно ввести только 1 contactId
gtldЕсли вы запрашиваете результат аудита cnnic-gtld, установите этот параметр в 1
XML-тег результата
Пояснение
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>Корневой узел XML-документа ответаXML документ
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<CnAuditStatus></CnAuditStatus>статус проверки записи аудита cnnic. Вы можете получить 'processing' или 'waiting for cnnic', или 'failed'. Если статус 'failed', мы отправим вам электронное письмо.
<FailedReason></FailedReason>Если проверка не пройдена, будет показана причина ошибки

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
Ответ (формат JSON)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на создание контакта
Пояснение
organization (optional)Информация об организации
nameИмя
emailЭлектронная почта
phonenumНомер телефона
phoneccКод страны телефона
faxnum (optional)Номер факса
faxcc (optional)Код страны факса
address1Адрес1
address2 (optional)Адрес 2
cityГород
state (optional)Штат
zipПочтовый индекс
countryСтрана
XML-тег результата
Пояснение
<CreateContactResponse></CreateContactResponse>Корневой узел XML-документа ответа
<CreateContactHeader></CreateContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<CreateContactContent></CreateContactContent>ID нового контакта, используется только когда статус равен "success"

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
Ответ (формат XML)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
Ответ (формат JSON)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса редактирования контакта
Пояснение
contact_idID контакта, который вы хотите отредактировать
organization (optional)Информация об организации
nameИмя
emailЭлектронная почта
phonenumНомер телефона
phoneccКод страны телефона
faxnum (optional)Номер факса
faxcc (optional)Код страны факса
address1Адрес 1
address2 (optional)Адрес 2
cityГород
stateШтат
zipПочтовый индекс
countryСтрана
XML-тег результата
Пояснение
<EditContactResponse></EditContactResponse>Корневой узел XML-документа ответа
<EditContactHeader></EditContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<EditContactContent></EditContactContent>Содержимое ответа
<ContactId></ContactId>ID контакта

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
Ответ (формат JSON)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
Запрос (формат CSV)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
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox 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
Ответ (формат CSV)
ok,

success,
,
 

Команда удаления контакта

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса удаления контакта
Пояснение
contact_idID контакта, который вы хотите удалить; убедитесь, что они разделены запятыми
XML-тег результата
Пояснение
<DeleteContactResponse></DeleteContactResponse>Корневой узел XML-документа ответа
<DeleteContactHeader></DeleteContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_contact&contact_id=0
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_contact&contact_id=0
Ответ (формат JSON)
{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса списка контактов
Пояснение
N/AДополнительные параметры не нужны
XML-тег результата
Пояснение
<ContactListResponse></ContactListResponse>Корневой узел XML-документа ответа
<ContactListHeader></ContactListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<ContactListContent></ContactListContent>Содержимое ответа
<ContactList></ContactList>Список контактов
<Contact></Contact>Контактная информация
<ContactId></ContactId>ID контакта
<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

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=contact_list
Ответ (формат XML)
<?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>
        <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>
        <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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=contact_list
Ответ (формат JSON)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack tester",
        "Email": "",
        "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": "",
        "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"
      }
    ]
  }
}
 

Команда получения контакта

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса получения контакта
Пояснение
contact_idID контакта
XML-тег результата
Пояснение
<GetContactResponse></GetContactResponse>Корневой узел XML-документа ответа
<GetContactHeader></GetContactHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetContactContent></GetContactContent>Содержимое ответа
<Contact></Contact>Контактная информация
<ContactId></ContactId>ID контакта
<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

Пример получения контакта

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_contact&contact_id=10000
Ответ (формат XML)
<?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>
        <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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_contact&contact_id=10000
Ответ (формат JSON)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

Команда настройки контакта для ЕС

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки контакта для ЕС
Пояснение
contact_idID контакта, который вы хотите отредактировать
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-тег результата
Пояснение
<SetContactEUSettingResponse></SetContactEUSettingResponse>Корневой узел XML-документа ответа
<SetContactEUSettingHeader></SetContactEUSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Содержимое ответа
<ContactId></ContactId>ID контакта

Пример настройки контакта для ЕС

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Ответ (формат JSON)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

Команда настройки LV контакта

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса настройки LV контакта
Пояснение
contact_idID контакта, который вы хотите отредактировать
registration_number- Для физических лиц, пожалуйста, введите латвийский идентификационный номер.
- Для компаний и других юридических лиц, пожалуйста, введите регистрационный номер, выданный Латвийским регистром предприятий.
vat_number (optional)Номер НДС для иностранных юридических лиц, зарегистрированных в странах Европейского союза (сюда также входят латвийские компании)
XML-тег результата
Пояснение
<SetContactLvSettingResponse></SetContactLvSettingResponse>Корневой узел XML-документа ответа
<SetContactLvSettingHeader></SetContactLvSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Содержимое ответа
<ContactId></ContactId>ID контакта

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Ответ (формат JSON)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Пример настройки LV для контакта

Запрос (формат CSV)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
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Ответ (формат CSV)
ok,success,0
 

Команда настройки LT контакта

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки LT контакта
Пояснение
contact_idID контакта, который вы хотите отредактировать
organization_codeКод организации контакта можно задать только после того, как задана организация контакта.
XML-тег результата
Пояснение
<SetContactLtSettingResponse></SetContactLtSettingResponse>Корневой узел XML-документа ответа
<SetContactLtSettingHeader></SetContactLtSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<SetContactLtSettingContent></SetContactLtSettingContent>Содержимое ответа
<ContactId></ContactId>ID контакта

Пример настройки LT контакта

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLtSettingResponse>
  <SetContactLtSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLtSettingHeader>
  <SetContactLtSettingContent>
    <ContactId>0</ContactId>
  </SetContactLtSettingContent>
</SetContactLtSettingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Ответ (формат JSON)
{
  "SetContactLtSettingResponse": {
    "ResponseCode:": "0",
    "Status": "Success",
    "SetContactLtSettingContent": {
      "ContactId": "0"
    }
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на получение сервера имен
Пояснение
domainДомен, информацию о серверах имён которого вы хотите получить; за один запрос можно получить информацию о серверах имён только для 1 домена.
XML-тег результата
Пояснение
<GetNsResponse></GetNsResponse>Корневой узел XML-документа ответа
<GetNsHeader></GetNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<NsContent></NsContent>Содержимое ответа
<Host></Host>Имя хоста сервера
<NsName></NsName>Имя сервера

Пример получения NS

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
Ответ (формат JSON)
{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса добавления сервера имён
Пояснение
hostИмя хоста сервера имён, который вы хотите добавить
XML-тег результата
Пояснение
<AddNsResponse></AddNsResponse>Корневой узел XML-документа ответа
<AddNsHeader></AddNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<AddNsContent></AddNsContent>Содержимое ответа
<Server></Server>Установленный вами сервер
<Host></Host>Имя хоста нового сервера
<ServerId></ServerId>ID нового сервера

Пример добавления NS

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
Ответ (формат JSON)
{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на регистрацию сервера имен
Пояснение
hostИмя хоста вашего собственного сервера имён
ipIP-адрес вашего собственного сервера имён
XML-тег результата
Пояснение
<RegisterNsResponse></RegisterNsResponse>Корневой узел XML-документа ответа
<RegisterNsHeader></RegisterNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<RegisterNsContent></RegisterNsContent>Содержимое ответа
<Server></Server>Тег сервера
<Host></Host>Имя хоста
<ServerId></ServerId>ID сервера

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Ответ (формат XML)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Ответ (формат JSON)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки IP-адреса NS-сервера
Пояснение
server_idID NS-сервера, который вы хотите установить
ip0 - ip9IP-адрес, который вы хотите установить для сервера имен, за один запрос можно установить 9 IP-адресов, и их нужно разделять запятыми
XML-тег результата
Пояснение
<SetNsIpResponse></SetNsIpResponse>Корневой узел XML-документа ответа
<SetNsIpHeader></SetNsIpHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример установки IP-адреса сервера имен

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Ответ (формат XML)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Ответ (формат JSON)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда удаления сервера имён

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на удаление сервера имен
Пояснение
server_idID серверов имен, которые вы хотите удалить; убедитесь, что они разделены запятыми.
XML-тег результата
Пояснение
<DeleteNsResponse></DeleteNsResponse>Корневой узел XML-документа ответа
<DeleteNsHeader></DeleteNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns&server_id=0
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns&server_id=0
Ответ (формат JSON)
{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Команда удаления NS-сервера по домену

Поддержка многопоточности
Поддержка API Sandbox

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

Удалить сервер имен по параметру запроса домена
Пояснение
server_domainИмя сервера имён. напр.: ns1.testnameserver.com
XML-тег результата
Пояснение
<DeleteNsResponse></DeleteNsResponse>Корневой узел XML-документа ответа
<DeleteNsHeader></DeleteNsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Ответ (формат XML)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Ответ (формат JSON)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса списка серверов
Пояснение
N/AДополнительные параметры не нужны
XML-тег результата
Пояснение
<ServerListResponse></ServerListResponse>Корневой узел XML-документа ответа
<ServerListHeader></ServerListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<ServerListContent></ServerListContent>Содержимое ответа
<NameServerList></NameServerList>Список серверов имён
<List></List>
<Server></Server>
<ServerId></ServerId>ID сервера
<ServerName></ServerName>Имя сервера
<ServerIp></ServerIp>IP-адрес сервера

Пример списка серверов

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=server_list
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=server_list
Ответ (формат JSON)
{
  "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"
          }
        ]
      }
    ]
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на получение настроек NS-серверов домена
Пояснение
domainДомен, настройки сервера имён которого вы хотите получить, за один запрос можно получить настройки сервера имён только для 1 домена.
XML-тег результата
Пояснение
<GetDnsResponse></GetDnsResponse>Корневой узел XML-документа ответа
<GetDnsHeader></GetDnsHeader>Заголовок ответа
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetDnsContent></GetDnsContent>Содержимое ответа
<NameServerSettings></NameServerSettings>Настройки серверов имён домена
<Type></Type>Тип сервера имен домена

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
Ответ (формат JSON)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

Команда информации об аккаунте

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса информации об аккаунте
Пояснение
N/AДополнительные параметры не нужны
XML-тег результата
Пояснение
<AccountInfoResponse></AccountInfoResponse>Корневой узел XML-документа ответа
<AccountInfoHeader></AccountInfoHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "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>ID контакта
<DefaultAdmin></DefaultAdmin>Администратор по умолчанию
<DefaultTechnical></DefaultTechnical>Технический по умолчанию
<DefaultBilling></DefaultBilling>Оплата по умолчанию
<Type></Type>Тип сервера имён
<WithAds></WithAds>С рекламой или без

Пример информации об аккаунте

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=account_info
Ответ (формат XML)
<?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>
        <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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=account_info
Ответ (формат JSON)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "AvatarUrl": "test avatar url",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "",
        "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"
        }
      }
    }
  }
}
 

Команда получения баланса аккаунта

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса получения баланса аккаунта
Пояснение
N/AДополнительные параметры не нужны
XML-тег результата
Пояснение
<GetAccountBalanceResponse></GetAccountBalanceResponse>Корневой узел XML-документа ответаXML документ
<GetAccountBalanceHeader></GetAccountBalanceHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Содержимое ответа
<Balance></Balance>Баланс счета

Пример получения баланса аккаунта

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_account_balance
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_account_balance
Ответ (формат JSON)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

Установить Whois по умолчанию

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса Whois по умолчанию
Пояснение
registrant_contactИнформация о регистранте домена
admin_contactИнформация об администраторе домена
technical_contactТехническая информация о домене
billing_contactПлатёжная информация домена
XML-тег результата
Пояснение
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Корневой узел XML-документа ответа
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример установки Whois по умолчанию

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Ответ (формат XML)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Ответ (формат JSON)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки серверов имен по умолчанию
Пояснение
ns0 - ns12Серверы имен, которые вы хотите задать
XML-тег результата
Пояснение
<SetDefaultNsResponse></SetDefaultNsResponse>Тег ответа set default name servers — это корневой узел XML-документа ответа
<SetDefaultNsHeader></SetDefaultNsHeader>Тег заголовка настройки серверов имен по умолчанию
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<SetDefaultNsContent></SetDefaultNsContent>Тег содержимого set default name servers, используется только когда статус равен "success"
<Servers></Servers>Информация о серверах, которые вы настроили
<Server></Server>Каждый сервер
<ServerName></ServerName>Имя сервера
<ServerId></ServerId>ID сервера

Пример установки Ns по умолчанию

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Ответ (формат JSON)
{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки парковки по умолчанию
Пояснение
with_ads (optional)Если вы не хотите рекламу третьих лиц, вы можете использовать этот параметр со значением "no", значение по умолчанию — "yes"
XML-тег результата
Пояснение
<SetDefaultParkingResponse></SetDefaultParkingResponse>Корневой узел XML-документа ответа
<SetDefaultParkingHeader></SetDefaultParkingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки парковки по умолчанию

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
Ответ (формат XML)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
Ответ (формат JSON)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки переадресации по умолчанию
Пояснение
forward_urlURL-адрес, на который вы хотите перенаправлять ваш домен. Обратите внимание, что параметр должен быть закодировано чтобы вызов API был интерпретирован правильно.
is_temp (optional)Желаемый статус переадресации вашего домена, значение по умолчанию — "temporary". Если вы хотите переадресовывать навсегда, используйте этот параметр со значением "no"
XML-тег результата
Пояснение
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Корневой узел XML-документа ответа
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример установки пересылки по умолчанию

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Ответ (формат XML)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Ответ (формат JSON)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда установки Stealth по умолчанию

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса Stealth по умолчанию
Пояснение
stealth_urlURL-адрес, на который вы хотите перенаправлять ваш домен. Обратите внимание, что параметр должен быть закодировано чтобы вызов API был интерпретирован правильно.
stealth_title (optional)Заголовок страницы
XML-тег результата
Пояснение
<SetDefaultStealthResponse></SetDefaultStealthResponse>Корневой узел XML-документа ответа
<SetDefaultStealthHeader></SetDefaultStealthHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Ответ (формат XML)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Ответ (формат JSON)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда установки хостинга по умолчанию

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки хостинга по умолчанию
Пояснение
hosting_typeТип хостинга по умолчанию, который вы хотите; можно выбрать в "advanced" и "basic"
XML-тег результата
Пояснение
<SetDefaultHostingResponse></SetDefaultHostingResponse>Корневой узел XML-документа ответа
<SetDefaultHostingHeader></SetDefaultHostingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки хостинга по умолчанию

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
Ответ (формат XML)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
Ответ (формат JSON)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда установки DNS по умолчанию

Поддержка многопоточности
Поддержка API Sandbox

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

( Эта команда устарела и не рекомендуется, вместо неё используйте команду установки DNS2 по умолчанию )

Установить параметр DNS-запроса по умолчанию
Пояснение
main_record_typeОсновной тип записи
main_recordУкажите DNS-запись для вашего домена
main_txt (optional)Укажите TXT-запись для вашего домена. Если ваш main_record_type — aaaa и указан main_record2, можно задать до 3 main_txts, иначе можно задать до 4 main_txts.
main_record2Основная запись 2, используется только когда "main_record_type" имеет значение "aaaa". Её значение должно быть в формате ipv4.
subdomain0 - subdomain99 (optional)Записи поддомена
sub_record_type0 - sub_record_type99 (optional)Тип записей поддомена
sub_record0 - sub_record99 (optional)IP-адрес или целевой хост
mx_host0 - mx_host2 (optional)Укажите почтовый хост для вашего домена, distance0 имеет наивысший приоритет.
mx_distance0 - mx_distance2 (optional)Distance0 имеет наивысший приоритет
ttl (optional)Время жизни
XML-тег результата
Пояснение
<SetDefaultDnsResponse></SetDefaultDnsResponse>Корневой узел XML-документа ответа
<SetDefaultDnsHeader></SetDefaultDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример установки DNS по умолчанию

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Ответ (формат XML)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Ответ (формат JSON)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда установки DNS2 по умолчанию

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на установку DNS2 по умолчанию
Пояснение
main_record_type0 - main_record_type19Основной тип записи
main_record0 - main_record19Укажите DNS-запись для вашего домена
main_recordx0 - main_recordx19MX-расстояние, тип переадресации, заголовок stealth-переадресации или псевдоним email, необходимо, когда main_record — "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
subdomain0 - subdomain99 (optional)Записи поддомена
sub_record_type0 - sub_record_type99 (optional)Тип записей поддомена
sub_record0 - sub_record99 (optional)IP-адрес поддомена или целевой хост
sub_recordx0 - subdo_recordx99Расстояние MX, тип переадресации, заголовок скрытой переадресации или псевдоним email — необходимо, когда sub_record_type равен "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email".
ttl (optional)Время жизни
XML-тег результата
Пояснение
<SetDefaultDnsResponse></SetDefaultDnsResponse>Корневой узел XML-документа ответа
<SetDefaultDnsHeader></SetDefaultDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример установки DNS2 по умолчанию

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Ответ (формат XML)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Ответ (формат JSON)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда установки пересылки электронной почты по умолчанию

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки переадресации электронной почты по умолчанию
Пояснение
forward_typeТип переадресации. Может быть "donot": не пересылать email, "mx": доставлять email на другой почтовый хост (MX-запись), "forward": доставлять 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-тег результата
Пояснение
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Корневой узел XML-документа ответа
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки пересылки электронной почты по умолчанию

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Ответ (формат XML)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Ответ (формат JSON)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда Set Clear Default Setting

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки и сброса настройки по умолчанию
Пояснение
serviceСервис, который вы хотите очистить, может быть "forward", "stealth", "email_forwarding", "dns" и "nameservers"
XML-тег результата
Пояснение
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Корневой узел XML-документа ответа
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример установки и сброса настройки по умолчанию

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
Ответ (формат XML)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
Ответ (формат JSON)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки опции продления по умолчанию
Пояснение
renew_optionМожет быть "donot", "auto", "reset"
XML-тег результата
Пояснение
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Корневой узел XML-документа ответа
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
Ответ (формат JSON)
{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на создание папки
Пояснение
folder_nameНазвание папки, которую вы хотите создать
XML-тег результата
Пояснение
<FolderCreateResponse></FolderCreateResponse>Корневой узел XML-документа ответа
<FolderCreateHeader></FolderCreateHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<FolderCreateContent></FolderCreateContent>Содержимое ответа
<FolderName></FolderName>название папки
<FolderId></FolderId>ID новой папки

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_folder&folder_name=new
Ответ (формат XML)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_folder&folder_name=new
Ответ (формат JSON)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

Команда удаления папки

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса удаления папки
Пояснение
folder_idID папок, которые вы хотите удалить; убедитесь, что они разделены запятыми
XML-тег результата
Пояснение
<DeleteFolderResponse></DeleteFolderResponse>Корневой узел XML-документа ответа
<DeleteFolderHeader></DeleteFolderHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
Ответ (формат JSON)
{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}
 

Команда настройки Whois для папки

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса Whois для папки
Пояснение
folder_idID папки, который вы хотите установить
registrant_contactИнформация о регистранте домена
admin_contactИнформация об администраторе домена
technical_contactТехническая информация о домене
billing_contactПлатёжная информация домена
enable (optional)Если вы хотите применить эту настройку Whois к будущим доменам, которые вы переместите в эту папку, вы можете использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать эту настройку Whois для всех доменов в этой папке, вы можете использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderWhoisResponse></SetFolderWhoisResponse>Корневой узел XML-документа ответа
<SetFolderWhoisHeader></SetFolderWhoisHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример Set Folder Whois

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Ответ (формат XML)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Ответ (формат JSON)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки серверов имён папки
Пояснение
fold_idID папки, которую вы хотите задать, только 1 папка может быть задана за запрос
ns0 - ns12NS-серверы, которые нужно назначить для вашего домена; можно указать до 13 NS-серверов, но они уже должны быть в вашем аккаунте.
enable (optional)Если вы хотите применять эту настройку серверов имён к будущим доменам, которые вы переместите в эту папку, можете использовать этот параметр со значением "yes".
sync (optional)Если вы хотите синхронизировать настройки серверов имён для всех доменов в этой папке, используйте этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderNsResponse></SetFolderNsResponse>Тег ответа сервера set folder name, это корневой узел XML-документа ответа
<SetFolderNsHeader></SetFolderNsHeader>Тег заголовка ответа сервера имён для заданной папки
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<SetFolderNsContent></SetFolderNsContent>Тег содержимого ответа сервера имен для заданной папки, используется только когда статус — "success"
<Servers></Servers>Информация о серверах, которые вы настроили
<Server></Server>Каждый сервер
<ServerName></ServerName>Имя сервера
<ServerId></ServerId>ID сервера

Пример настройки NS для папки

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Ответ (формат XML)
<?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>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Ответ (формат JSON)
{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на настройку парковки для папки
Пояснение
folder_idID папки, которую вы хотите задать, только 1 папка может быть задана за запрос
with_ads (optional)Если вы не хотите рекламу третьих лиц, вы можете использовать этот параметр со значением "no", значение по умолчанию — "yes"
enable (optional)Если вы хотите применить эту настройку парковки к будущим доменам, которые вы переместите в эту папку, вы можете использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать настройку парковки для всех доменов в этой папке, вы можете использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderParkingResponse></SetFolderParkingResponse>Корневой узел XML-документа ответа
<SetFolderParkingHeader></SetFolderParkingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Ответ (формат XML)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Ответ (формат JSON)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда настройки переадресации для папки

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса на настройку пересылки папки
Пояснение
folder_idID папки, который вы хотите установить
forward_urlURL-адрес, на который вы хотите перенаправлять ваш домен. Обратите внимание, что параметр должен быть закодировано чтобы вызов API был интерпретирован правильно.
is_temp (optional)Желаемый статус переадресации вашего домена, значение по умолчанию — "temporary". Если вы хотите переадресовывать навсегда, используйте этот параметр со значением "no"
enable (optional)Если вы хотите применить эту настройку переадресации к будущим доменам, которые вы переместите в эту папку, можно использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать настройку переадресации для всех доменов в этой папке, можете использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderForwardingResponse></SetFolderForwardingResponse>Корневой узел XML-документа ответа
<SetFolderForwardingHeader></SetFolderForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки переадресации для папки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Ответ (формат XML)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Ответ (формат JSON)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса установки скрытности папки
Пояснение
folder_idID папки, которую вы хотите задать
stealth_urlURL-адрес, на который вы хотите перенаправлять ваш домен. Обратите внимание, что параметр должен быть закодировано чтобы вызов API был интерпретирован правильно.
stealth_title (optional)Заголовок страницы
enable (optional)Если вы хотите применить эту настройку stealth к будущим доменам, которые вы переместите в эту папку, можете использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать настройку скрытой переадресации для всех доменов в этой папке, можете использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderStealthResponse></SetFolderStealthResponse>Корневой узел XML-документа ответа
<SetFolderStealthHeader></SetFolderStealthHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки Stealth для папки

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Ответ (формат XML)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Ответ (формат JSON)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда настройки хостинга папки

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса хостинга папки
Пояснение
folder_idID папки, который вы хотите установить
hosting_typeТип хостинга, который вы хотите, можно выбрать из "advanced" и "basic"
enable (optional)Если вы хотите применять эту настройку хостинга к будущим доменам, которые вы переместите в эту папку, используйте этот параметр со значением "yes"
even (optional)Если вы хотите синхронизировать настройки хостинга для всех доменов в этой папке, можно использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderHostingResponse></SetFolderHostingResponse>Корневой узел XML-документа ответа
<SetFolderHostingHeader></SetFolderHostingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки хостинга для папки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Ответ (формат XML)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Ответ (формат JSON)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда настройки DNS для папки

Поддержка многопоточности
Поддержка API Sandbox

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

( Эта команда устарела и не рекомендуется, вместо неё используйте команду Set Folder DNS2 )

Параметр запроса установки DNS для папки
Пояснение
folder_idID папки, которую вы хотите установить
main_record_typeОсновной тип записи
main_recordУкажите DNS-запись для вашего домена
main_recordУкажите DNS-запись для вашего домена
with_ads (optional)Укажите TXT-запись для вашего домена. Если ваш main_record_type — aaaa и указан main_record2, можно задать до 3 main_txts, иначе можно задать до 4 main_txts.
main_record2Основная запись 2, используется только когда "main_record_type" имеет значение "aaaa". Её значение должно быть в формате ipv4.
subdomain0 - subdomain99 (optional)Записи поддомена (необязательно)
sub_record_type0 - sub_record_type99 (optional)Тип записей поддомена
sub_record0 - sub_record99 (optional)IP-адрес или целевой хост
mx_host0 - mx_host2 (optional)Укажите почтовый хост для вашего домена, distance0 имеет наивысший приоритет.
mx_distance0 - mx_distance2 (optional)Distance0 имеет наивысший приоритет
ttl (optional)Время жизни
enable (optional)Если вы хотите применить эту настройку DNS к будущим доменам, которые переместите в эту папку, можно использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать эту настройку DNS-сервера для всех доменов в этой папке, вы можете использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderDnsResponse></SetFolderDnsResponse>Корневой узел XML-документа ответа
<SetFolderDnsHeader></SetFolderDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки DNS для папки

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Ответ (формат XML)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Ответ (формат JSON)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса Set Folder DNS2
Пояснение
folder_idID папки, которую вы хотите установить
main_record_type0 - main_record_type19Основной тип записи, должен быть "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Укажите DNS-запись для вашего домена
main_recordx0 - main_recordx19Расстояние MX, тип переадресации, заголовок скрытой переадресации или псевдоним электронной почты; необходимо, когда main_record_type имеет значение "forward","mx","stealth","email"
subdomain0 - subdomain99 (optional)Записи поддомена (необязательно)
sub_record_type0 - sub_record_type99 (optional)Тип записей поддомена, должен быть "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (optional)IP-адрес или целевой хост
sub_recordx0 - sub_recordx99 (optional)Расстояние MX, тип переадресации, заголовок скрытой переадресации или псевдоним электронной почты; необходим, когда sub_record_type имеет значение "forward","mx","stealth","email"
ttl (optional)Время жизни
enable (optional)Если вы хотите применить эту настройку DNS к будущим доменам, которые переместите в эту папку, можно использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать эту настройку DNS-сервера для всех доменов в этой папке, вы можете использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderDnsResponse></SetFolderDnsResponse>Корневой узел XML-документа ответа
<SetFolderDnsHeader></SetFolderDnsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Ответ (формат JSON)
{
  "SetFolderDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Команда Set Folder Email Forward

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки пересылки электронной почты для папки
Пояснение
domainДоменное имя, которое вы хотите установить, за один запрос можно установить 100 доменов, убедитесь, что они разделены запятыми
folder_idID папки, которую вы хотите настроить
forward_typeТип переадресации. Может быть "donot": не пересылать email, "mx": доставлять email на другой почтовый хост (MX-запись), "forward": доставлять 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"
enable (optional)Если вы хотите применить эту настройку к будущим доменам, которые вы переместите в эту папку, можете использовать этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать эту настройку для всех доменов в этой папке, можно использовать этот параметр со значением "yes"
XML-тег результата
Пояснение
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Корневой узел XML-документа ответа
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки пересылки email для папки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Ответ (формат XML)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Ответ (формат JSON)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда настройки очистки папки

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки очистки папки
Пояснение
folder_idID папки, который вы хотите установить
serviceСервис, который вы хотите очистить, может быть "forward", "stealth", "email_forwarding", "dns" и "nameservers"
XML-тег результата
Пояснение
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Корневой узел XML-документа ответа
<SetClearFolderSettingHeader></SetClearFolderSettingHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки очистки папки

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Ответ (формат XML)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Ответ (формат JSON)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Установить параметр запроса имени папки
Пояснение
folder_idID папки, которую вы хотите задать
folder_nameНазвание новой папки
XML-тег результата
Пояснение
<SetFolderNameResponse></SetFolderNameResponse>Корневой узел XML-документа ответа
<SetFolderNameHeader></SetFolderNameHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
Ответ (формат XML)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
Ответ (формат JSON)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса настройки опции продления папки
Пояснение
folder_idID папки, которую вы хотите задать, только 1 папка может быть задана за запрос
renew_optionОпция продления, которую вы хотите установить для папки; может быть "donot", "auto" или "reset"
enable (optional)Если вы хотите применять эту настройку продления к будущим доменам, которые вы переместите в эту папку, используйте этот параметр со значением "yes"
sync (optional)Если вы хотите синхронизировать настройки продления для всех доменов в этой папке, используйте этот параметр со значением "yes"
XML-тег результата
Пояснение
<Response></Response>Корневой узел XML-документа ответа
<ResponseHeader></ResponseHeader>Заголовок ответа
<ResponseCode></ResponseCode>Код ответа: "0" — успешно, "-1" — ошибка.
<Error></Error>Информация об ошибке, используется только когда код ответа равен "-1"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Ответ (формат XML)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Ответ (формат JSON)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса списка папок
Пояснение
N/AДополнительные параметры не нужны
<FolderListResponse></FolderListResponse>Корневой узел XML-документа ответа
<FolderListHeader></FolderListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<FolderListContent></FolderListContent>Содержимое ответа
<FolderList></FolderList>Список папок
<List></List>
<Folder></Folder>
<FolderId></FolderId>ID папки
<FolderName></FolderName>Имя папки
<DefaultWhois></DefaultWhois>Whois по умолчанию
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Статус включения Whois по умолчанию
<DefaultRegistrant></DefaultRegistrant>Регистрант по умолчанию
<ContactId></ContactId>ID контакта
<DefaultAdmin></DefaultAdmin>Администратор по умолчанию
<DefaultTechnical></DefaultTechnical>Техническая информация по умолчанию
<DefaultBilling></DefaultBilling>Платёжная информация по умолчанию
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Статус включения серверов имен по умолчанию
<NameServerSettings></NameServerSettings>Настройки сервера имен
<Type></Type>Тип сервера имён
<WithAds></WithAds>С рекламой или без
<DefaultRenewOption></DefaultRenewOption>Опция продления по умолчанию
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Статус включения опции продления по умолчанию
<RenewOption></RenewOption>Опция продления
<DefaultTransferLock></DefaultTransferLock>Блокировка переноса по умолчанию
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Статус включения блокировки переноса по умолчанию
<LockStatus></LockStatus>Статус блокировки

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=folder_list
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=folder_list
Ответ (формат JSON)
{
  "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"
        }
      }
    ]
  }
}
 

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

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса на добавление обратного заказа
Пояснение
domainДомен(ы), которые вы хотите добавить и за которые согласны заплатить, если Dynadot их поймает, за один запрос можно добавить 100 доменов; они должны быть разделены запятыми.
XML-тег результата
Пояснение
<AddBackorderRequestResponse></AddBackorderRequestResponse>Корневой узел XML-документа ответа
<AddBackorderRequestHeader></AddBackorderRequestHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Ответ (формат XML)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Ответ (формат JSON)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда удаления запроса на бэкордер

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса удаления заявки на бэкдордер
Пояснение
domainДомен(ы), которые вы хотите удалить из списка запросов на backorder, за один запрос можно удалить 100 доменов, они должны быть разделены запятыми
XML-тег результата
Пояснение
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Корневой узел XML-документа ответа
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
Ответ (формат XML)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
Ответ (формат JSON)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Команда списка запросов на бэкордер

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса списка заявок на бэккордер
Пояснение
start_dateДата начала дропа аукциона, который вы хотите запросить, yyyy-mm-dd, например 2015-05-05
end_dateКонечная дата дропа аукциона, который вы хотите запросить, yyyy-mm-dd, например 2015-05-05
XML-тег результата
Пояснение
<BackorderRequestListResponse></BackorderRequestListResponse>Корневой узел XML-документа ответа
<BackorderRequestListHeader></BackorderRequestListHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<BackorderRequestListContent></BackorderRequestListContent>Содержимое ответа
<BackorderRequestList></BackorderRequestList>Список запросов на бэкордер
<BackorderRequest></BackorderRequest>Запрос на бэкордер
<Domain></Domain>Домен в вашем списке
<CutoffTime></CutoffTime>Дата отсечения для удаления запроса в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года)
<BackorderRequestStatus></BackorderRequestStatus>Статус в процессе перехвата домена

Пример списка запросов на backorder

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Ответ (формат JSON)
{
  "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"
      }
    ]
  }
}
Запрос (формат CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Ответ (формат CSV)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
 

Команда получения открытых аукционов

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get open auctions вернет список аукционов, которые находятся в процессе. При вызове этой команды следует включить следующие параметры:

Параметр запроса получения открытых аукционов
Пояснение
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
type (optional)Тип аукциона, который вы хотите просмотреть; он должен быть "expired", "user", "backorder" или "registry_expired", "registrar". Если вы хотите получить более одного типа аукциона, можете разделять каждый тип аукциона с помощью ","
count_per_pageСколько сущностей отображается на странице (максимум 1000)
page_index Сущности какой страницы вы хотите просмотреть
has_bids (optional)Если этот параметр имеет значение true, будут возвращены только аукционы, по которым уже были ставки. Если false — аукционы без ставок. Если не передан — все аукционы.
XML-тег результата
Пояснение
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Тег ответа на запрос открытых аукционов, это корневой узел XML-документа ответа
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Получить заголовок открытых аукционов
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Tag of get open auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID аукциона
<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>Возраст домена

Пример получения открытых аукционов

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Ответ (формат XML)
<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&count_per_page=20&page_index=1

Ответ

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

Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Ответ (формат JSON)
{
    "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": "-"
        }
        ...
    ]
}
 

Команда получения деталей аукциона

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get auction details вернет подробности указанного аукциона. Эта команда доступна только в формате XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Параметр запроса получения деталей аукциона
Пояснение
domainДоменное имя аукциона, IDN(международное доменное имя) должно использовать punycode, например "xn--wkccg.com". Вы можете получить более одного аукциона, каждое доменное имя должно быть разделено ","
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
XML-тег результата
Пояснение
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Тег ответа на запрос деталей аукциона; это корневой узел XML-документа ответа
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Заголовок получения деталей аукциона бэклордера
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>ID статуса аукциона: '0' — в процессе, '1' — отменён пользователем, '2' — отменён администратором, '3' — отменён из-за продления, '4' — завершён, '5' — отменён из-за передачи домена
<AuctionStatus></AuctionStatus>Статус аукциона
<UserIsHighBid></UserIsHighBid>Если пользователь сделал наивысшую ставку
<YourCurrentBid></YourCurrentBid>Ваша текущая ставка для указанного аукциона. Если вы не делали ставку, она будет '-1'
<YourProxyBid></YourProxyBid>Ваш прокси-ставка для указанного аукциона. Если вы не сделали ставку, это будет '-1'
<AuctionId></AuctionId>ID аукциона
<Domain></Domain>Доменное имя на аукционе
<BidPrice></BidPrice>Текущая ставка на аукционе
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок на аукционе
<EndTime></EndTime>Время окончания аукциона
<EndTimestamp></EndTimestamp>Дата окончания аукциона в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года)
<IsPremium></IsPremium>Является ли домен премиум-доменом
<RenewalPrice></RenewalPrice>Цена продления

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Ответ (формат JSON)
{
  "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": "",
        "dyna_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": []
    }
  ]
}
 

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

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get auction bids вернёт список ваших ставок, в которых вы участвовали. При вызове этой команды должны быть включены следующие параметры:

Параметр запроса на получение ставок аукциона
Пояснение
currency (optional)Валюта вашей ставки, она должна быть "usd", "eur" или "cny", валюта по умолчанию — доллары США
count_per_pageСколько сущностей отображается на странице (максимум 50)
page_index Сущности какой страницы вы хотите просмотреть
XML-тег результата
Пояснение
<GetAuctionBidsResponse></GetAuctionBidsResponse>Тег ответа get auction bids, он является корневым узлом XML-документа ответа
<GetAuctionBidsHeader></GetAuctionBidsHeader>Заголовок Get auction bids
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> Список ставок
<Bid></Bid> Предмет ставки
<BidId></BidId> ID ставки
<AuctionId></AuctionId> ID аукциона
<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>Метка времени окончания аукциона

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Ответ (формат XML)
<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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Ответ (формат JSON)
{
    "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
        }
        ...
    ]
}
 

Команда размещения ставки на аукционе

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса на размещение ставки на аукционе
Пояснение
domainДоменное имя аукциона, IDN (интернационализированное доменное имя) должно использовать punycode, например "xn--wkccg.com"
bid_amountСумма вашей ставки на аукционе; валюта по умолчанию — доллары США, также её можно указать с помощью параметра currency ниже
currency (optional)Валюта вашей ставки, она должна быть "usd", "eur" или "cny", валюта по умолчанию — доллары США
XML-тег результата
Пояснение
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Тег ответа на ставку в аукционе, это корневой узел XML-документа ответа
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Заголовок для размещения ставки на аукционе
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример домена

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Ответ (формат XML)
<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

Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Ответ (формат JSON)
{
    "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
            }
            ...        ]
    }
}
 

Команда получения закрытых аукционов

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get closed auctions вернёт список закрытых аукционов указанного аккаунта. При вызове этой команды нужно указать следующие параметры:

Параметр запроса получения закрытых аукционов
Пояснение
start_dateМетка времени, указывающая начало времени завершения аукциона, yyyy-mm-dd, например 2015-05-05
end_dateВременная метка, указывающая время окончания аукциона, yyyy-mm-dd, например 2015-05-05
currency (optional)Валюта вашей ставки, она должна быть "usd", "eur" или "cny", валюта по умолчанию — доллары США
XML-тег результата
Пояснение
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Тег ответа get closed auctions, это корневой узел XML-документа ответа
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Заголовок закрытых аукционов
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID аукциона
<Domain></Domain>Доменное имя на аукционе
<AuctionStatusId></AuctionStatusId>ID статуса аукциона, '0' для В процессе и '1' для Закрыт пользователем, '2' для Закрыт администратором, '3' для Закрыт из-за продления, '4' для Закрыт по таймауту, '5' для Закрыт из-за передачи домена
<AuctionStatus></AuctionStatus>Статус аукциона
<BidPrice></BidPrice>Текущая ставка на аукционе
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок на аукционе
<AuctionWonStatus></AuctionWonStatus>Если пользователь выиграл этот аукцион
<YourHighBid></YourHighBid>Ваша максимальная ставка для этого аукциона
<YourProxyBid></YourProxyBid>Ваша прокси-ставка для этого аукциона

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Ответ (формат JSON)
{
  "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"
      }
    ]
  }
}
Запрос (формат CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Ответ (формат CSV)
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
 

Команда получения открытых аукционов по бэклордеру

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get open backorder auctions вернёт список аукционов по бэкордерам, которые проходят в данный момент. Если вызываете эту команду, следует указать следующие параметры:

Параметр запроса для получения открытых аукционов бэкордеров
Пояснение
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
XML-тег результата
Пояснение
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Тег ответа get open backorder auctions, это корневой узел XML-документа ответа
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Получить заголовок открытых аукционов по бэклордерам
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag of get open backorder auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID аукциона
<Domain></Domain>Доменное имя на аукционе
<BidPrice></BidPrice>Текущая ставка на аукционе
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок на аукционе
<EndTime></EndTime>Время окончания аукциона
<EndTimestamp></EndTimestamp>Дата окончания аукциона в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года)

Пример получения открытых бэклордер-аукционов

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_backorder_auctions&currency=usd
Ответ (формат XML)
<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
.
.
.

 

Команда получения деталей аукциона предзаказа

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get backorder auction details возвращает сведения об указанном аукционе. Эта команда доступна только в формате XML и JSON. При вызове этой команды следует включить следующие параметры:

Параметр запроса получения деталей аукциона
Пояснение
domainДоменное имя аукциона предзаказа, для IDN(International Domain Name) следует использовать punycode, например "xn--wkccg.com"
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
XML-тег результата
Пояснение
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Тег ответа на запрос деталей аукциона; это корневой узел XML-документа ответа
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Заголовок получения деталей аукциона
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>ID статуса аукциона, '0' для В процессе и '1' для Закрыт пользователем, '2' для Закрыт администратором, '3' для Закрыт из-за продления, '4' для Закрыт по таймауту, '5' для Закрыт из-за передачи домена
<AuctionStatus></AuctionStatus>Статус аукциона
<AuctionId></AuctionId>ID аукциона
<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'
<YourProxyBid></YourProxyBid>Ваш прокси-ставка для указанного аукциона. Если вы не сделали ставку, это будет '-1'

Пример получения деталей аукциона обратного заказа

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Ответ (формат JSON)
{
  "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"
      }
    }
  }
}
 

Команда размещения ставки на аукционе Backorder

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса на размещение ставки в аукционе по бэкордеру
Пояснение
domainДоменное имя аукциона, IDN (интернационализированное доменное имя) должно использовать punycode, например "xn--wkccg.com"
bid_amountСумма вашей ставки на аукционе; валюта по умолчанию — доллары США, также её можно указать с помощью параметра currency ниже
currency (optional)Валюта вашей ставки, она должна быть "usd", "eur" или "cny", валюта по умолчанию — доллары США
XML-тег результата
Пояснение
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Тег ответа на ставку в аукционе, это корневой узел XML-документа ответа
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Заголовок для размещения ставки на аукционе
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Ответ (формат XML)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Ответ (формат JSON)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
Запрос (формат CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Ответ (формат CSV)
ok,success
 

Команда получения закрытых Backorder-аукционов

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды get closed backorder auctions вернёт список закрытых бэкордер-аукционов для указанного аккаунта. При вызове этой команды необходимо указать следующие параметры:

Параметр запроса получения закрытых аукционов бэкордера
Пояснение
start_dateДата начала аукциона, yyyy-mm-dd, например 2015-05-05
end_dateДата окончания аукциона, yyyy-mm-dd, например 2015-05-05
currency (optional)Валюта вашей ставки, она должна быть "usd", "eur" или "cny", валюта по умолчанию — доллары США
XML-тег результата
Пояснение
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Тег ответа get closed auctions, это корневой узел XML-документа ответа
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Заголовок закрытых аукционов
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<YourHighBid></YourHighBid>Ваша максимальная ставка для этого аукциона
<YourProxyBid></YourProxyBid>Ваша прокси-ставка для этого аукциона
<AuctionId></AuctionId>ID аукциона
<Domain></Domain>Доменное имя на аукционе
<AuctionStatusId></AuctionStatusId>ID статуса аукциона, '0' для В процессе и '1' для Закрыт пользователем, '2' для Закрыт администратором, '3' для Закрыт из-за продления, '4' для Закрыт по таймауту, '5' для Закрыт из-за передачи домена
<AuctionStatus></AuctionStatus>Статус аукциона
<BidPrice></BidPrice>Текущая ставка на аукционе
<BidPriceCurrency></BidPriceCurrency>Валюта ставки
<Bids></Bids>Количество ставок на аукционе

Пример получения закрытых аукционов по бэкордерам

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Ответ (формат JSON)
{
  "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"
      }
    ]
  }
}
Запрос (формат CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Ответ (формат CSV)
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
 

Получить команду для истекших доменов Closeout

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса на получение истекших Closeout-доменов
Пояснение
currency(optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
domain(optional)Добавьте этот параметр, если вы хотите найти домен, выставленный на распродажу
count_per_page (optional)Сколько сущностей отображается на странице
page_index (optional)Сущности какой страницы вы хотите просмотреть
XML-тег результата
Пояснение
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Тег ответа на команду получения просроченных Closeout-доменов, это корневой узел XML-документа ответа
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Получить заголовок доменов с истёкшим сроком в распродаже
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>Элемент распродажи
<DomainName></DomainName>Доменное имя
<DomainNameUtf></DomainNameUtf>Доменное имя указано в формате utf
<CurrentPrice></CurrentPrice>текущая цена
<isIdn></isIdn>Является ли это IDN-доменным именем
<EndTimeStamp></EndTimeStamp>Дата окончания аукциона в Unix-времени (миллисекунды с полуночи UTC 1 января 1970 года)
<RenewalPrice></RenewalPrice>Цена продления
<ExpiredRevenue></ExpiredRevenue>Доход от распродажи
<DynaAppraisal></DynaAppraisal>DynaAppraisal
<InboundLinks></InboundLinks>Входящие ссылки домена
<MonthlyVisitors></MonthlyVisitors>Посетители домена
<Currency></Currency>Валюта

Пример получения просроченных Closeout-доменов

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Ответ (формат JSON)
{
  "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"
        }
      }
    ]
  }
}
 

Команда покупки просроченного Closeout-домена

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды Buy Expired Closeout Domain приведёт к покупке указанного доменного имени. Эта команда доступна только в форматах XML и JSON. При вызове этой команды необходимо указать следующие параметры:

Параметр запроса на покупку истекшего домена в закрытии
Пояснение
domainДомен, который вы хотите купить; за один запрос можно указать только 1 домен
currency(optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
XML-тег результата
Пояснение
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Тег ответа Buy Expired Closeout Domain, это корневой узел XML-документа ответа
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Заголовок покупки просроченного домена Closeout
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример покупки домена с истёкшим сроком в Closeout

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Ответ (формат JSON)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Команда получения листингов

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса Get Listings
Пояснение
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
exclude_pending_sale (optional)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
show_other_registrar (optional)Если вы хотите получить списки других регистраторов, должно быть "yes", по умолчанию — "no"
count_per_pageСколько сущностей отображается на странице. (максимум 20000)
page_indexСущности какой страницы вы хотите просмотреть.
XML-тег результата
Пояснение
<GetListingsResponse></GetListingsResponse>Корневой узел XML-документа ответаXML документ
<GetListingsHeader></GetListingsHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetListingsContent></GetListingsContent>Содержимое листинга
<Listing></Listing>Содержимое элемента листинга
<ListingId></ListingId>ID объявления
<Domain></Domain>Доменное имя
<Price></Price>Цена
<InBoundLinks></InBoundLinks>Количество входящих ссылок
<Age></Age>Возраст

Пример получения листингов

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Ответ (формат XML)
<?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>
      <Type>BIN</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>MAKE_OFFER</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Ответ (формат JSON)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Total": 2,
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "BIN"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "MAKE_OFFER"
      }
    ]
  }
}
 

Команда получения элемента листинга

Поддержка многопоточности
API Sandbox не поддерживается

При вызове команды get listing item следует включить следующие параметры:

Параметр запроса получения элемента листинга
Пояснение
domainДоменное имя, по которому вы хотите получить подробную информацию; в одном запросе можно указать только 1 домен
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; валюта по умолчанию — доллары США.
XML-тег результата
Пояснение
<GetListingItemResponse></GetListingItemResponse>Корневой узел XML-документа ответаXML документ
<GetListingItemHeader></GetListingItemHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetListingsItemContent></GetListingsItemContent>Содержимое листинга
<Listing></Listing>Содержимое элемента листинга
<ListingId></ListingId>ID объявления
<Domain></Domain>Доменное имя
<Price></Price>Цена
<InBoundLinks></InBoundLinks>Количество входящих ссылок
<Age></Age>Возраст

Пример получения элемента списка

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
Ответ (формат XML)
<?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>
      <Type>BIN</Type>
      <RegistrationDate>1791875010218</RegistrationDate>
      <ExpirationDate>1791875010218</ExpirationDate>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
Ответ (формат JSON)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No",
      "RegistrationDate": 1791875010218,
      "ExpirationDate": 1791875010218,
      "Type": "BIN"
    }
  }
}
 

Команда покупки сейчас

Поддержка многопоточности
API Sandbox не поддерживается

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

Параметр запроса Купить сейчас
Пояснение
domainДомен, который вы хотите купить; за один запрос можно указать только 1 домен
currency (optional)Валюта возвращаемого результата; должна быть "usd", "eur" или "cny"; если валюта не указана, будет применена валюта аккаунта по умолчанию.
price_to_verify (optional)Ожидаемая цена buy_it_now для проверки перед покупкой. Если фактическая цена в листинге не совпадает с этим значением, запрос завершится ошибкой.
XML-тег результата
Пояснение
<BuyItNowResponse></BuyItNowResponse>Корневой узел XML-документа ответаXML документ
<BuyItNowHeader></BuyItNowHeader>Заголовок ответа
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<Message></Message>Должно быть "domain order created", используется только когда статус — "success".

Пример «Купить сейчас»

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
  <BuyItNowContent>
    <OrderId>1</OrderId>
  </BuyItNowContent>
</BuyItNowResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Ответ (формат JSON)
{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderId": 1
  }
}
 

Команда добавления нового лида

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды добавления нового лида импортирует ваши собственные лиды в систему Dynadot с комиссией 5%.

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

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

Параметр запроса добавления нового лида
Пояснение
domain_nameДоменное имя, для которого вы хотите добавить лид; за один запрос можно ввести только 1 домен
lead_typeтип лида, который вы хотите установить. Допустимые значения: "buy_now", "make_offer"
priceцена, которую вы хотите установить для лида
buyer_nameимя покупателя
buyer_emailэлектронная почта покупателя
XML-тег результата
Пояснение
<AddNewLeadResponse></AddNewLeadResponse>корневой узел ответа
<AddNewLeadHeader></AddNewLeadHeader>Заголовок добавления нового лида
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример добавления нового лида

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<AddNewLeadResponse>
  <AddNewLeadHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AddNewLeadHeader>
</AddNewLeadResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Ответ (формат JSON)
{
  "AddNewLeadResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

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

Поддержка многопоточности
API Sandbox не поддерживается

Эта команда поддерживает многопоточность.

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

Установить параметр запроса для продажи
Пояснение
domainsДомен, который вы хотите выставить на продажу в Domain Marketplace; за один запрос можно указать только 1 домен
for_sale_typeВы можете выбрать значение из следующего списка, чтобы указать тип продажи:
> торговая площадка:
Выставить ваш домен на продажу в Маркетплейс доменов. Новые доменные лоты будут установлены в категорию, подкатегорию и цену, указанные ниже. Если установлена фактическая цена, домен будет доступен для немедленной покупки и передан покупателю. Подробнее о процессе продажи домена >

> не_для_продажи:
отменить листинг
listing_type (optional)Вы можете выбрать значение из следующего списка, чтобы представить ваш тип продажи через маркет: (обязательно, если for_sale_type — marketplace)
> buy_now
Установка фиксированной цены сделает домен доступным для немедленной покупки и отправит его покупателю.
Примечание: Для домена в льготном периоде добавления, если произошла продажа, он может больше не подлежать удалению в льготном периоде. Дополнительная информация о Льготное удаление

> make_offer
Вы можете установить минимальную цену предложения или оставить поле пустым, чтобы разрешить любую сумму предложения.
Примечание: Для домена в льготном периоде добавления, если произошла продажа, он может больше не подлежать удалению в льготном периоде. Дополнительная информация о Льготное удаление

> buy_now_and_make_offer Установка фиксированной цены сделает домен доступным для немедленной покупки и передаст его покупателю.
Вы можете установить минимальную цену предложения или оставить поле пустым, чтобы разрешить любую сумму предложения.
Примечание: Для домена в льготном периоде добавления, если произошла продажа, он может больше не подлежать удалению в льготном периоде. Дополнительная информация о Льготное удаление
price (optional)цена, за которую вы хотите продать свой домен. (обязательно, если for_sale_type — marketplace)
minimum_offer (optional)минимальное предложение, которое вы примете за свой домен. (обязательно, если for_sale_type — marketplace)
installment (optional)Разрешена ли оплата в рассрочку. Если вы хотите включить оплату в рассрочку, установите значение "Yes"
maximum_installments (optional)Максимальное количество рассрочек разрешено, используется только когда installment равен "true"
Вы можете выбрать значение от 2 до 12, чтобы указать максимальное количество месяцев для оплаты в рассрочку
category (optional)выберите категорию для вашего домена, Вы можете обратиться к таблице сравнения категорий и подкатегорий ниже для необязательного заполнения.
Sub-category (optional)выберите подкатегорию для вашего домена, можете обратиться к таблице сравнения категорий и подкатегорий ниже для выбора.
Примечание: значение вашего параметра должно быть числом, соответствующим подкатегории.
КатегорияПодкатегория
advertisingmarketing
retail
sales
automotivecars_trucks
enthusiasts
motorsports
businessinvestment
law
money
professions
services
careers_educationNo subCategory
consumer_goods_servicesapparel
electronics
entertainmentgames
pop_culture
fashionNo subCategory
financeNo subCategory
gamblingcasino
sports
healthfitness
medicine
internetblogs
ecommerce
domains
web_design
web_hosting
otherNo subCategory
placesafrica
asia
europe
north_america
south_america
real_estateNo subCategory
scienceNo subCategory
societyculture
news
politics
religion
sportsleisure_activities
professional
technologycomputers
uncategorizedNo subCategory
adultNo subCategory
homeNo subCategory
aiNo subCategory
aerospaceNo subCategory
agencyNo subCategory
agriculture_companyNo subCategory
analyticsNo subCategory
alcoholNo subCategory
babies_kidsNo subCategory
biotechNo subCategory
clean_energyNo subCategory
cleaningNo subCategory
communityNo subCategory
construction_organizationNo subCategory
cryptocurrency_blockchainNo subCategory
dating_relationshipNo subCategory
daycareNo subCategory
dentalNo subCategory
droneNo subCategory
e_commerceNo subCategory
food_drinkNo subCategory
furnitureNo subCategory
gamesNo subCategory
insuranceNo subCategory
interior_designNo subCategory
legal_lawNo subCategory
motivationalNo subCategory
manufacturingNo subCategory
marketingNo subCategory
medicalNo subCategory
metaverseNo subCategory
movies_tvNo subCategory
music_audioNo subCategory
news_mediaNo subCategory
nftNo subCategory
outdoorNo subCategory
paymentNo subCategory
petsNo subCategory
politicsNo subCategory
property_managementNo subCategory
recruitment_staffingNo subCategory
servicesNo subCategory
securityNo subCategory
socialNo subCategory
transportationNo subCategory
travelNo subCategory
video_books_magazinesNo subCategory
virtual_realityNo subCategory
website_designNo subCategory
Description (optional)Описание вашего домена
XML-тег результата
Пояснение
<SetForSaleResponse></SetForSaleResponse>корневой узел ответа
<SetForSaleHeader></SetForSaleHeader>Заголовок Выставить на продажу
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
Ответ (формат JSON)
{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}
 

Команда списка доменов для исходящего переноса

Поддержка многопоточности
Поддержка API Sandbox

Вызов команды списка исходящих трансферов доменов вернёт список доменов, находящихся в процессе исходящего трансфера. Эта команда доступна только в формате XML и JSON. Если вызвать эту команду

Параметр запроса списка доменов для перевода наружу
Пояснение
XML-тег результата
Пояснение
<TransferOutDomainListResponse></TransferOutDomainListResponse>корневой узел ответа
<TransferOutDomainListHeader></TransferOutDomainListHeader>Заголовок списка доменов для передачи
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<TransferOutDomainListContent></TransferOutDomainListContent>Заголовок списка доменов для передачи
<TransferOutDomainList></TransferOutDomainList>Список доменов для исходящего переноса
<Domain></Domain>Доменное имя
<OrderId></OrderId>ID заказа на исходящий перенос домена
<ItemStatus></ItemStatus>Статус передачи домена наружу

Пример списка доменов для исходящего трансфера

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer_domain_list
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer_domain_list
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<TransferOutDomainListResponse>
  <TransferOutDomainListHeader>
    <ResponseCode>200</ResponseCode>
    <Status>success</Status>
  </TransferOutDomainListHeader>
  <TransferOutDomainListContent>
    <TransferOutDomainList>
      <TransferOutDomain>
        <OrderId>1</OrderId>
        <Domain>domain1.com</Domain>
        <ItemStatus>Pending</ItemStatus>
      </TransferOutDomain>
    </TransferOutDomainList>
  </TransferOutDomainListContent>
</TransferOutDomainListResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer_domain_list
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer_domain_list
Ответ (формат JSON)
{
  "TransferOutDomainListResponse": {
    "ResponseCode": 200,
    "Status": "success",
    "TransferOutDomainList": [
      {
        "orderId": 1,
        "domain": "domain1.com",
        "itemStatus": "Pending"
      }
    ]
  }
}
 

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

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды Set Afternic Confirm Action установит для домена одобрение или отклонение fast-transfer в Afternic. Эта команда доступна только в формате XML и JSON. При вызове этой команды должны быть указаны следующие параметры:

Параметр запроса настройки подтверждения действия Afternic
Пояснение
domainДомен, для которого вы хотите задать действие Afternic confirm fast transfer; за один запрос можно ввести только 1 домен
actionДействие, которое вы хотите задать для подтверждения Afternic: должно быть "confirm_afternic" или "delete_from_afternic"
XML-тег результата
Пояснение
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Тег ответа на действие Set Afternic Confirm Action, это корневой узел XML-документа ответа
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Установить заголовок подтверждения действия Afternic
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Ответ (формат JSON)
{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Установить команду подтверждения действия Sedo

Поддержка многопоточности
API Sandbox не поддерживается

Вызов команды Set Sedo Confirm Action установит для домена одобрение или отклонение fast-transfer на Sedo. Эта команда доступна только в формате XML и JSON. При вызове этой команды должны быть включены следующие параметры:

Задать параметр запроса подтверждения действия Sedo
Пояснение
domainДомен, для которого вы хотите установить действие подтверждения быстрой передачи Sedo, за один запрос можно ввести только 1 домен.
actionДействие, которое вы хотите задать для подтверждения Sedo; оно должно быть "confirm_sedo" или "delete_from_sedo"
XML-тег результата
Пояснение
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Тег ответа Set Sedo Confirm Action, это корневой узел XML-документа ответа
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>Установить заголовок подтверждения действия Sedo
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"

Пример настройки действия подтверждения Sedo

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Ответ (формат JSON)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Команда получения статистики Whois

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса статистики Whois
Пояснение
domain_nameДоменное имя, для которого нужно настроить DNSSEC
date_typeВы можете выбрать поле из следующего списка, чтобы представить ваш тип даты:
last_7_days, last_30_days, current_year, last_year
XML-тег результата
Пояснение
<GetWhoisStatsResponse></GetWhoisStatsResponse>корневой узел ответа
<GetWhoisStatsHeader></GetWhoisStatsHeader>Заголовок получения статистики Whois
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetWhoisStatsContent></GetWhoisStatsContent>содержимое ответа
<WhoisStats></WhoisStats>Содержит несколько наборов данных статистики whois
<WhoisStat></WhoisStat>Конкретные данные статистики Whois
<Date></Date>Минимальный интервал времени
<Count></Count>Количество whois за текущий интервал времени

Пример получения статистики Whois

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetWhoisStatsResponse>
  <GetWhoisStatsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetWhoisStatsHeader>
  <GetWhoisStatsContent>
    <WhoisStats>
      <WhoisStat>
        <Date>2023-11-04</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-05</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-06</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-07</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-08</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-09</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-10</Date>
        <Count>200</Count>
      </WhoisStat>
    </WhoisStats>
  </GetWhoisStatsContent>
</GetWhoisStatsResponse>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Ответ (формат JSON)
{
  "GetWhoisStatsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "WhoisStats": [
      {
        "Date": "2023-11-04",
        "Count": 200
      },
      {
        "Date": "2023-11-05",
        "Count": 300
      },
      {
        "Date": "2023-11-06",
        "Count": 100
      },
      {
        "Date": "2023-11-07",
        "Count": 200
      },
      {
        "Date": "2023-11-08",
        "Count": 300
      },
      {
        "Date": "2023-11-09",
        "Count": 100
      },
      {
        "Date": "2023-11-10",
        "Count": 200
      }
    ]
  }
}
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса списка заказов
Пояснение
search_byВы можете выбрать значение из следующего списка, чтобы указать тип поиска: date_range, domain, order_id
start_dateначальная дата вашего запроса в формате yyyy/MM/dd
end_dateдата окончания вашего запроса в формате yyyy/MM/dd
payment_methodВы можете выбрать несколько значений из следующего списка, чтобы указать способ оплаты:
none_balance
баланс_аккаунта
кредитная_карта
денежный_заказ
Paypal
Moneybooker
банковский_перевод
Alipay
payflow_credit_card2 (больше не используется)
wechat_pay
ecash
банковский_перевод
apple_pay
checking_account
продажа
union_pay
учетная_запись_paypal
mercado_pago
Payoneer
но, пожалуйста, используйте запятую для разделения нескольких значений, например: account_balance,credit_card
XML-тег результата
Пояснение
<OrderListResponse></OrderListResponse>корневой узел ответа
<OrderListHeader></OrderListHeader>Заголовок списка заказов
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<OrderListContent></OrderListContent>Заголовок списка заказов
<OrderList></OrderList>Содержит несколько наборов данных журнала заказов
<OrderItem></OrderItem>Содержит данные журнала одного заказа
<OrderItemDomain></OrderItemDomain>Доменное имя, которое включает элементы в этом порядке
<OrderId></OrderId>Содержит идентификатор заказа
<SubmittedDate></SubmittedDate>Содержит дату отправки заказа
<Cost></Cost>Содержит стоимость заказа
<Status></Status>Содержит статус заказа

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

Запрос (формат XML)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
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox 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
Ответ (формат XML)
<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1791875010219</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>1791875010219</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>
Запрос (формат JSON)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
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox 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
Ответ (формат JSON)
{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2026/10/13",
        "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": "2026/10/13",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}
 

Команда получения статуса заказа

Поддержка многопоточности
Поддержка API Sandbox

Вызов команды Get Order Status позволит получить статус заказа. Эта команда доступна только в формате XML и JSON. Если вы вызываете эту команду, необходимо указать следующие параметры:

Параметр запроса получения статуса заказа
Пояснение
order_idID заказа, который нужно запросить
XML-тег результата
Пояснение
<GetOrderStatusResponse></GetOrderStatusResponse>корневой узел ответа
<GetOrderStatusHeader></GetOrderStatusHeader>Заголовок получения статуса заказа
<ResponseCode></ResponseCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "error"
<GetOrderStatusContent></GetOrderStatusContent>содержимое ответа
<OrderId></OrderId>ID заказа
<OrderStatus></OrderStatus>статус заказа (Shopping, Submitted, Waitpay, Processing, Completed, Problem, Deleted, Cancelled)
<ItemTypeName></ItemTypeName>Тип элемента
<ItemName></ItemName>Название элемента
<ItemStatus></ItemStatus>Статус позиции (Completed, Cancelled, Problem)

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Запрос в песочнице (формат XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Запрос в песочнице (формат JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Ответ (формат JSON)
{
  "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"
        }
      ]
    }
  }
}
 

Команда 'В процессе'

Поддержка многопоточности
Поддержка API Sandbox

Вызов команды is_processing покажет, безопасно ли отправлять новый запрос

Параметр запроса Is-Processing
Пояснение
дополнительный параметр не нужен
XML-тег результата
Пояснение
<Response></Response>Тег ответа is_processing
<ResponseHeader></ResponseHeader>Тег заголовка is_processing
<ResponseMsg></ResponseMsg>Tag of is_processing response message. It should be "yes"(There is a process in the system. You shouldn't sent another request.) or "no"(There is no any process for you account. It is safe to submit a new request.)

Пример 'В процессе'

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=is_processing
Ответ (формат XML)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=is_processing
Ответ (формат JSON)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
Запрос (формат CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing
Запрос в песочнице (формат CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=is_processing
Ответ (формат CSV)
ok,yes
 

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

Поддержка многопоточности
Поддержка API Sandbox

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

Параметр запроса списка купонов
Пояснение
coupon_typeВы можете выбрать значение из следующего списка, чтобы указать тип поиска: "registration" , "renewal" , или "transfer"
XML-тег результата
Пояснение
<ListCouponsResponse></ListCouponsResponse>корневой узел ответа
<ListCouponsHeader></ListCouponsHeader>Заголовок списка купонов
<SuccessCode></SuccessCode>Если операция выполнена успешно, "0" означает успех, "-1" — ошибку
<Status></Status>Статус запроса
<Error></Error>Информация об ошибке запроса, используется только если status — "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>Дата окончания срока действия купона

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

Запрос (формат XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_coupons&coupon_type=renewal
Запрос в песочнице (формат XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
Ответ (формат XML)
<?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>
Запрос (формат JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=list_coupons&coupon_type=renewal
Запрос в песочнице (формат JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
Ответ (формат JSON)
{
  "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"
      }
    ]
  }
}