Domínios

Lista de Comandos da API de Domínios

Nossa API é seu kit avançado de gerenciamento e aquisição de domínios, criado para eficiência. Com mais de 50 comandos para configurar, gerenciar, registrar e dar lances em toda a plataforma Dynadot, você terá controle total sobre sua conta e configurações de domínio em qualquer software de API de sua escolha. Nossa API de domínios está disponível para todas as contas, então comece hoje mesmo!

Introdução à Nossa API Avançada de Domínios

API legada, com desativação programada. Em vez disso, use nossa API RESTful:

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

As requisições para nossa API Avançada de Domínios são enviadas para a seguinte URL:

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

As solicitações devem ser enviadas por https (soquete seguro) por segurança. A solicitação deve ter os dois parâmetros a seguir, um 'Key' e um 'Command'. Cada comando pode ser clicado para ver os parâmetros associados a ele.

Você receberá diferentes quantidades de threads com base no Nível de gastos da sua conta:

Nível de GastoContagem de threadsLimite de taxa
Regular1 thread60/min (1/seg)
Em Lote5 threads600/min (10/seg)
super lote35 threads6000/min (100/seg)

 
Parâmetro de solicitação
Explicação
KeySua chave para acessar a API, disponível no painel de controle da sua conta Dynadot, no menu lateral 'Ferramentas' -> 'API'.
Command
Domínio:
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
contato:
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
Servidor de nomes:
get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns
Conta:
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
Pasta:
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
Mercado secundário:
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
Outro:
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

Formato XML. A resposta que você recebe deve conter 2 ou 3 dos seguintes campos:

Tag XML de resultado
Explicação
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
 

Comando de Pesquisa

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando de pesquisa, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de pesquisa
Explicação
domain0 - domain99O nome de domínio que você está pesquisando, conta regular pode especificar 1 domínio por comando, contas bulk e super bulk podem especificar até 100 domínios
language0 - language99 (optional)A tag de idioma para o respectivo domínio, use isto apenas para IDNs
show_price (optional)Se você quiser mostrar o preço na moeda da sua conta, defina-o como "1". Se o domínio estiver disponível, seus detalhes premium e informações de preço serão exibidos.
currency (optional)Você pode decidir o tipo de moeda e os valores suportados para este parâmetro são "USD","CNY", "GBP","EUR","INR","CAD" e assim por diante. Se você omitir este parâmetro, usaremos a moeda padrão da conta
Tag XML de resultado
Explicação
<Results></Results>O nó raiz da resposta XML do comando de pesquisa
<SearchResponse></SearchResponse>Tag da resposta de pesquisa
<SearchHeader></SearchHeader>Tag do cabeçalho de pesquisa
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<DomainName></DomainName>O nome de domínio que você acabou de pesquisar
<Available></Available>Se o nome de domínio estiver disponível
<Price></Price>Se você definir "show_price" como "1", isso mostrará as informações de preço se este domínio estiver disponível.
<Language></Language>Informações de idioma sobre o nome de domínio

Exemplo de pesquisa

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Solicitação de Sandbox (Formato 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
Resposta (Formato 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"
         }
      ]
   }
}
 

Comando de Registro

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando register, será criado e processado um pedido de registro. Você precisa ter saldo suficiente na conta para pagar pelo pedido. Ao chamar o comando register, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de registro
Explicação
domainO nome de domínio que você deseja registrar, apenas 1 domínio pode ser registrado por solicitação
language (optional)A tag de idioma para o domínio solicitado, necessária apenas se o domínio for um IDN
durationPor quanto tempo registrar o domínio
registrant_contact (optional)O contato do titular que você deseja usar no domínio
admin_contact (optional)O contato administrativo que você deseja usar no domínio
technical_contact (optional)O contato técnico que você deseja usar no domínio
billing_contact (optional)O contato de cobrança que você deseja usar no domínio
option0 (if necessary)
O nome do titular .AT, .BE
option1 (if necessary)A organização do titular para .AT, .BE (opcional)
Para .AT, você pode especificar option0, option1 ou ambos
premium (optional)Se você quiser registrar um domínio premium, defina-o como "1" (opcional)
currency (optional)Você pode decidir o tipo de moeda e os valores suportados para este parâmetro são "USD","CNY", "GBP","EUR","INR","CAD" e assim por diante. Se você omitir este parâmetro, usaremos a moeda padrão da conta
coupon (optional)O código do cupom que você deseja aplicar a este comando
Tag XML de resultado
Explicação
<RegisterResponse></RegisterResponse>Tag da resposta de registro
<RegisterHeader></RegisterHeader>Tag do cabeçalho de registro
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<RegisterContent></RegisterContent>A tag do conteúdo de registro
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970), usada apenas quando o resultado é "success"
<Registration></Registration>Data de registro em Unix time (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970), usada apenas quando o resultado for "success"

Exemplo de Registro

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Resposta (Formato JSON)
{
  "RegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.net",
    "Expiration": 1458379145266
  }
}
 

Comando Excluir

Suporte a multi-thread
Suporte a API Sandbox

Chamar o comando de exclusão excluirá um domínio que ainda está no período de carência. O saldo da sua conta será creditado de volta com a taxa de registro. Domínios que foram renovados ou que foram movidos para uma nova conta não podem ser excluídos pela API. Se chamar o comando de exclusão, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de exclusão
Explicação
domainO nome de domínio que você deseja excluir, apenas 1 domínio pode ser excluído por solicitação
Tag XML de resultado
Explicação
<DeleteResponse></DeleteResponse>Tag da resposta de exclusão
<DeleteHeader></DeleteHeader>Etiqueta do cabeçalho de exclusão
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de exclusão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete&domain=domain1.com
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete&domain=domain1.com
Resposta (Formato JSON)
{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}
 

Comando de Renovação

Suporte a multi-thread
Suporte a API Sandbox

Chamar o comando renew criará e processará um pedido de renovação. Você precisa ter saldo suficiente na conta para pagar o pedido. Se chamar o comando renew, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de renovação
Explicação
domainO nome de domínio que você deseja renovar, apenas 1 domínio pode ser renovado por solicitação
durationPor quantos anos renovar o domínio
year (optional)O ano atual em que o domínio expira
currency (optional)Você pode decidir o tipo de moeda e os valores suportados para este parâmetro são "USD","CNY", "GBP","EUR","INR","CAD" e assim por diante. Se você omitir este parâmetro, usaremos a moeda padrão da conta
price_check (optional)Você pode adicionar este parâmetro ao comando para verificar o detalhe do preço para renovar este domínio. NOTA: Ao adicionar este parâmetro ao comando, nossa api não renovará o domínio, mas apenas exibirá as informações de preço.
coupon (optional)O código do cupom que você deseja aplicar a este comando
no_renew_if_late_renew_fee_needed (optional)Você pode adicionar este parâmetro ao comando para evitar a renovação se o domínio exigir taxa de renovação atrasada. Se o domínio exigir taxa de renovação atrasada para renovar, e "no_renew_if_late_renew_fee_needed = 1" for passado no comando, o domínio não será renovado.
Tag XML de resultado
Explicação
<RenewResponse></RenewResponse>Tag da resposta de renovação, é o nó raiz do documento XML de resposta
<RenewHeader></RenewHeader>Cabeçalho de renovação
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<PriceInfo></PriceInfo>Tag das informações de preço, é usada apenas quando o status é "price_check_success"
<RenewContent></RenewContent>Tag do conteúdo de renovação, é usada apenas quando o status é "success"
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970), usada apenas quando o resultado é "success"

Exemplo de renovação

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Resposta (formato XML)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Resposta (Formato JSON)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}
 

Comando Push

Suporte a multi-thread
Suporte a API Sandbox

Chamar o comando push criará e processará uma ordem de push. Você deve desbloquear seu domínio e sua conta para a ordem. A conta receptora precisa rejeitar/aceitar o domínio para concluir a ordem. Se chamar o comando push, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de push
Explicação
domainO nome de domínio que você deseja fazer push. Também suportamos push em massa; você pode usar ";" para separar domínios. Exemplo: domain1.com;domain2.com
receiver_push_usernameNome de usuário Push da conta do destinatário
currency (optional)Você pode decidir o tipo de moeda e os valores suportados para este parâmetro são "USD","CNY", "GBP","EUR","INR","CAD" e assim por diante. Se você omitir este parâmetro, usaremos a moeda padrão da conta
unlock_domain_for_push(optional)Defina este parâmetro como "1". Se o domínio estiver bloqueado, vamos desbloqueá-lo automaticamente, então você não precisa desbloquear o domínio manualmente
receiver_email(optional)E-mail de push da conta receptora
Tag XML de resultado
Explicação
<PushResponse></PushResponse>Tag da resposta de push, é o nó raiz do documento XML de resposta
<PushHeader></PushHeader>Cabeçalho de push
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de push

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Resposta (formato XML)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Resposta (Formato JSON)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

Comando de Transferência

Suporte a multi-thread
Suporte a API Sandbox

Chamar o comando de transferência criará e processará uma ordem de transferência. Alguns TLDs podem exigir que o registrador de perda confirme para concluir a ordem. Se você chamar o comando de transferência, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de transferência
Explicação
domainO nome de domínio que você deseja transferir para a Dynadot, apenas 1 domínio pode ser transferido por solicitação
authO código de autorização para a solicitação de transferência.
currency (optional)Você pode decidir o tipo de moeda e os valores suportados para este parâmetro são "USD","CNY", "GBP","EUR","INR","CAD" e assim por diante. Se você omitir este parâmetro, usaremos a moeda padrão da conta
registrant_contact (optional)O contato do registrante que você deseja usar quando a transferência for concluída. (Nem todos os TLDs suportam este recurso)
admin_contact (optional)O contato administrativo que você deseja usar quando a transferência for concluída. (Nem todos os TLDs suportam este recurso)
technical_contact (optional)O contato técnico que você deseja usar quando a transferência for concluída. (Nem todos os TLDs suportam este recurso)
billing_contact (optional)O contato de cobrança que você deseja usar quando a transferência for concluída. (Nem todos os TLDs suportam esse recurso)
premium (optional)Se você quiser transferir um domínio premium, defina como "1" (opcional)
privacy (optional)O status de privacidade do domínio que você deseja definir pode ser "on" ou "off". O nível de privacidade padrão da conta será aplicado se uma entrada incorreta ou nenhuma entrada for fornecida
name_servers (optional)A lista de servidores de nomes a aplicar ao domínio assim que a transferência estiver concluída. Você pode usar "," para separar servidores de nomes. Exemplo: ns1.domain1.com,ns2.domain2.com
coupon (optional)O código do cupom que você deseja aplicar a este comando
Tag XML de resultado
Explicação
<TransferResponse></TransferResponse>Tag da resposta de transferência, é o nó raiz do documento XML de resposta
<TransferHeader></TransferHeader>Cabeçalho de transferência
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Transferência

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Resposta (Formato JSON)
{
  "TransferResponse": {
    "ResponseCode": 0,
    "Status": "order created",
    "DomainName": "domain1.com",
    "OrderId": "1234567"
  }
}
 

Comando de registro em massa

Suporte a multi-thread
Suporte a API Sandbox

Chamar o comando bulk register criará e processará pedidos de registro. Você precisa ter saldo suficiente na conta para pagar pelos pedidos. Se estiver chamando o comando bulk register, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Registro em Massa
Explicação
domain0-domain99O(s) nome(s) de domínio que você deseja registrar, no máximo 100 domínios podem ser registrados por solicitação
premium (optional)Se você quiser registrar um domínio premium, defina-o como "1" (opcional)
currency (optional)Você pode decidir o tipo de moeda e os valores suportados para este parâmetro são "USD", "CNY", "GBP", "EUR", "INR", "CAD" e assim por diante. Se você omitir este parâmetro, usaremos a moeda padrão da conta
coupon (optional)O código do cupom que você deseja aplicar a este comando
Tag XML de resultado
Explicação
<BulkRegisterResponse></BulkRegisterResponse>Tag da resposta de registro em massa
<BulkRegisterHeader></BulkRegisterHeader>Tag do cabeçalho de registro em massa
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<BulkRegisterContent></BulkRegisterContent>A tag do conteúdo de registro em massa
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970), usada apenas quando o resultado é "success"
<Result></Result>O resultado da ação de registro
<Message></Message>Mensagem de erro da ação de registro, usada apenas quando o resultado é "error"

Exemplo de Registro em Massa

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Resposta (Formato JSON)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

Comando de Informações do Domínio

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro de Solicitação de Informações do Domínio
Explicação
domainApenas 1 domínio permitido por solicitação
Tag XML de resultado
Explicação
<DomainInfoResponse></DomainInfoResponse>Nó raiz do documento XML de resposta
<DomainInfoResponseHeader></DomainInfoResponseHeader>Cabeçalho da resposta
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<DomainInfoContent></DomainInfoContent>Conteúdo da resposta
<Domain></Domain>Domínio
<Name></Name>Nome do domínio
<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970)
<Registration></Registration>Data de registro do domínio em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970)
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio
<Type></Type>Tipo de servidor de nomes do domínio
<WithAds></WithAds>Se você quiser uma página de estacionamento para seu domínio
<Whois></Whois>Informações Whois
<Registrant></Registrant>Informações do registrante
<ContactId></ContactId>ID do contato
<Admin></Admin>Informações do administrador
<Technical></Technical>Informações técnicas
<Billing></Billing>Informações de cobrança
<Locked></Locked>Bloqueado ou não
<Disabled></Disabled>Status de ativação
<UdrpLocked></UdrpLocked>Bloqueado por UDRP ou não
<UdrpLocked></UdrpLocked>Bloqueado por UDRP ou não
<RegistrantUnverified></RegistrantUnverified>Titular não verificado
<Hold></Hold>Status de Bloqueio do Cliente/Registrador
<Privacy></Privacy>Status de privacidade
<isForSale></isForSale>Status de venda
<RenewOption></RenewOption>Opção de renovação
<Note></Note>Nota
<Folder></Folder>Informações da pasta
<FolderId></FolderId>ID da pasta
<FolderName></FolderName>Nome da pasta

Exemplo de informações de domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
Resposta (Formato 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"
    }
  }
}
 

Comando Definir Whois

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set Whois, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Solicitação Whois
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactA informação técnica do domínio
billing_contactAs informações de cobrança do domínio
Tag XML de resultado
Explicação
<SetWhoisResponse></SetWhoisResponse>Nó raiz do documento XML de resposta
<SetWhoisHeader></SetWhoisHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Definir exemplo de Whois

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando para definir servidores de nomes

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando de definir servidores de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação para Definir Servidores de Nome
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
ns0 - ns12Os servidores de nomes para definir que seu domínio use, você pode especificar até 13 servidores de nomes, mas eles já devem estar na sua conta
Tag XML de resultado
Explicação
<SetNsResponse></SetNsResponse>Tag da resposta de definição de servidor de nomes, é o nó raiz do documento XML de resposta
<SetNsHeader></SetNsHeader>Tag do cabeçalho de resposta de Definir Servidor de Nomes
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definição de NS

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Definir Estacionamento

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set parking, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de definição de estacionamento
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
with_ads (optional)Se você não quiser anúncios de terceiros, pode usar este parâmetro com "no"
Tag XML de resultado
Explicação
<SetParkingResponse></SetParkingResponse>Tag da resposta de Definir Parking, é o nó raiz do documento XML de resposta
<SetParkingHeader></SetParkingHeader>Definir cabeçalho da pasta de estacionamento
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de configuração de parking

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
Resposta (formato XML)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
Resposta (Formato JSON)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Encaminhamento

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando de definir encaminhamento, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Solicitação de Encaminhamento
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
forward_urlA URL para a qual você deseja que seu domínio encaminhe. Observe que o parâmetro deve ser codificado para que a chamada da API seja interpretada corretamente.
is_temp (optional)Status de encaminhamento do seu domínio que você deseja, o valor padrão é "temporary", se você quiser encaminhar permanentemente, use este parâmetro com "no"
Tag XML de resultado
Explicação
<SetForwardingResponse></SetForwardingResponse>Nó raiz do documento XML de resposta
<SetForwardingHeader></SetForwardingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de configuração de encaminhamento

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Definir comando Stealth

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set stealth, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Solicitação Stealth
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
stealth_urlA URL para a qual você deseja que seu domínio encaminhe. Observe que o parâmetro deve ser codificado para que a chamada da API seja interpretada corretamente.
stealth_title (optional)O título da página
Tag XML de resultado
Explicação
<SetStealthResponse></SetStealthResponse>Nó raiz do documento XML de resposta
<SetStealthHeader></SetStealthHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Configuração de Stealth

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Configuração de Hospedagem

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando de definir hospedagem, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de Definir Hospedagem
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
hosting_typeTipo de hospedagem que você deseja, pode selecionar em "advanced" e "basic"
mobile_view_onSomente quando hosting_type for "advanced", você pode usar este parâmetro como "yes"
Tag XML de resultado
Explicação
<SetHostingResponse></SetHostingResponse>Nó raiz do documento XML de resposta
<SetHostingHeader></SetHostingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de configuração de hospedagem

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir DNS2

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set DNS2, os seguintes parâmetros devem ser incluídos:

Observe que executar o comando SET_DNS2, por padrão, substituirá as configurações de DNS atuais. Para alterar esse comportamento e anexar as novas configurações de DNS em vez disso, você pode usar o parâmetro opcional add_dns_to_current_setting.

Definir Parâmetro de Solicitação DNS2
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
main_record_type0 - main_record_type19 (optional)Tipo de registro principal, deve ser "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância MX, tipo de encaminhamento (301 como "1", 302 como "2"), título do encaminhamento stealth ou alias de e-mail, necessário quando main_record_type for "forward","mx","stealth","email".
subdomain0 - subdomain99 (optional)Registros de subdomínio (opcional)
sub_record_type0 - sub_record_type99Tipo de registro de subdomínio, deve ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99Endereço IP do subdomínio ou host de destino
sub_recordx0 - sub_recordx99Distância MX, tipo de encaminhamento, título de encaminhamento stealth ou alias de e-mail, necessário quando main_record_type for "forward","mx","stealth","email"
ttl (optional)Tempo de vida
add_dns_to_current_setting (optional)se você quiser anexar as novas configurações de DNS às configurações de DNS existentes. Defina como "1" (opcional)
Tag XML de resultado
Explicação
<SetDnsResponse></SetDnsResponse>Nó raiz do documento XML de resposta
<SetDnsHeader></SetDnsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Definir Exemplo de DNS2

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando de Definição de Dnssec

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando Set Dnssec definirá o dnssec do domínio. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Você pode optar por preencher os valores dos parâmetros correspondentes na Opção com base no seu nome de domínio.

Opção 1 : domain_name , key_tag , digest_type , digest , algorithm

Opção 2 : domain_name , flags , public_key , algorithm

Observações: Selecione o número do rótulo correspondente como o valor do seu parâmetro, se houver.

Parâmetro de requisição Set Dnssec
Explicação
domain_nameO nome de domínio para o qual você precisa configurar o dnssec
key_tagTag da chave
digest_typeVocê pode escolher um número da seguinte lista para representar seu tipo de assinatura digital: SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)
digestDigite o valor correspondente ao tipo de digest que você selecionou
algorithmVocê pode escolher um número da lista a seguir para representar seu algoritmo de assinatura digital: RSA/MD5(1) Diffie-Hellman (2) DSA/SHA-1(3) Curva Elíptica (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) Curva ECDSA P-256 com SHA-256(13 Curva ECDSA P-384 com SHA-384(14) ED25519(15 ED448(16) Indireto (252) DNS Privado (253 OID Privado (254)
flagsVocê pode escolher um número da lista a seguir para representar seu símbolo de assinatura digital: ZSK(256) KSK(257)
public_keyA Chave Pública deve estar em codificação base64.
Tag XML de resultado
Explicação
<SetDnssecResponse></SetDnssecResponse>o nó raiz da resposta
<SetDnssecHeader></SetDnssecHeader>Definir cabeçalho Dnssec
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de Dnssec

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnssecResponse>
  <SetDnssecHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnssecHeader>
  <SetDnssecContent/>
</SetDnssecResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Limpar DNSSEC

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando Limpar DNSSEC limpará o DNSSEC do domínio. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro da requisição Clear Dnssec
Explicação
domain_nameO nome de domínio para o qual você precisa limpar o DNSSEC

Exemplo de Limpar DNSSEC

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<ClearDnssecResponse>
  <ClearDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ClearDnssecHeader>
</ClearDnssecResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Resposta (Formato JSON)
{
  "ClearDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Definir Encaminhamento de E-mail

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set email forward, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de encaminhamento de e-mail
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
forward_typeTipo de encaminhamento, pode ser "donot": Não encaminhar e-mail, "mx": Entregar e-mail para outro servidor de correio (registro MX), "forward": Entregar e-mail para outro servidor de correio
username0 - username9Nome de usuário, usado apenas quando "forward_type" for "forward"
exist_email0 - exist_email9Endereço de e-mail existente, usado apenas quando "forward_type" for "forward"
mx_host0 - mx_host2Host de e-mail, usado apenas quando "forward_type" for "mx"
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado apenas quando "forward_type" for "mx"
Tag XML de resultado
Explicação
<SetEmailForwardingResponse></SetEmailForwardingResponse>Nó raiz do documento XML de resposta
<SetEmailForwardingHeader></SetEmailForwardingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de configuração de encaminhamento de e-mail

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Solicitação de Sandbox (formato 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]
Resposta (formato XML)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Solicitação de Sandbox (Formato 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]
Resposta (Formato JSON)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Set Clear Domain Setting

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set clear domain setting, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para definir/limpar configuração de domínio
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
serviceO serviço que você deseja limpar pode ser "forward", "stealth", "email_forwarding", "dns", "dnssec" e "nameservers"
Tag XML de resultado
Explicação
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nó raiz do documento XML de resposta
<SetClearDomainSettingHeader></SetClearDomainSettingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Configuração de Limpeza de Domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Resposta (formato XML)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Resposta (Formato JSON)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Pasta

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set folder, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de definição de pasta
Explicação
domainO nome de domínio a ser atualizado, apenas 1 domínio pode ser definido por solicitação
folderO nome da pasta para a qual você deseja mover seu domínio. Use "Default" como nome da pasta se quiser mover o domínio para a pasta padrão. O nome da pasta diferencia maiúsculas de minúsculas. Por exemplo, "Folder1" e "folder1" são dois nomes de pasta diferentes.
folder_id (optional)O ID da pasta para onde você quer mover seu domínio
Tag XML de resultado
Explicação
<SetFolderResponse></SetFolderResponse>Tag da resposta de definição de pasta, é o nó raiz do documento XML de resposta
<SetFolderHeader></SetFolderHeader>Definir cabeçalho da pasta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
Resposta (formato XML)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
Resposta (Formato JSON)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Nota

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set note, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definir Nota
Explicação
domainO domínio que você deseja definir, apenas 1 domínio pode ser definido por solicitação
noteNota que você deseja definir para o domínio, pode ser nula
Tag XML de resultado
Explicação
<SetNoteResponse></SetNoteResponse>Nó raiz do documento XML de resposta
<SetNoteHeader></SetNoteHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Nota

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Resposta (formato XML)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Resposta (Formato JSON)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Definir opção de renovação

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set renew option, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para definir opção de renovação
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
renew_optionPode ser "donot", "auto", "reset"
Tag XML de resultado
Explicação
<SetRenewOptionResponse></SetRenewOptionResponse>Nó raiz do documento XML de resposta
<SetRenewOptionHeader></SetRenewOptionHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Opção de Renovação

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Resposta (Formato JSON)
{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Definir Privacidade

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set privacy, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de definição de privacidade
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
optionO status de privacidade do domínio que você deseja definir pode ser "full", "partial" ou "off"
whois_privacy_optionO status de privacidade whois do domínio que você deseja definir, pode ser "yes" ou "no"
Tag XML de resultado
Explicação
<SetPrivacyResponse></SetPrivacyResponse>Nó raiz do documento XML de resposta
<SetPrivacyHeader></SetPrivacyHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de privacidade

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Resposta (formato XML)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Resposta (Formato JSON)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Preços de TLD

Suporte a multi-thread
Suporte a API Sandbox

Este recurso está disponível apenas no formato XML e JSON:

Parâmetro de Solicitação de Preços de TLD
Explicação
currency (optional)A moeda do resultado de retorno, deve ser "usd", "eur" ou "cny", a moeda padrão é Api Default Currency da configuração da conta
count_per_page (optional)Quantas entidades são exibidas por página
page_index (optional)Quais entidades da página você deseja visualizar
sort (optional)Selecione uma das opções a seguir como valor para o parâmetro de classificação:
* Se você não selecionou, usaremos a classificação padrão.
1) RankAsc (Padrão)
2) RankDesc
3) NomeAsc
4) NomeDesc
5) SalesAsc
6) SalesDesc
7) LaunchDateAsc
8) Descrição da Data de Lançamento
9) CountAsc
10) CountDesc
11) RegistryAsc
12) Descrição do Registro
Tag XML de resultado
Explicação
<TldPriceResponse></TldPriceResponse>Nó raiz do documento XML de resposta
<TldPriceResponseHeader></TldPriceResponseHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<TldPriceContent></TldPriceContent>Conteúdo da resposta
<TldContent></TldContent>Informações de TLD
<Tld></Tld>Domínios de nível superior
<Usage></Usage>Uso de tld
<Price></Price>Informações de preço deste TLD. Contém sub-tags: : Unidade de preço : Preço do Registro : Preço da renovação : Preço da Transferência
<Privacy></Privacy>Se este TLD oferece suporte a privacidade WHOIS
<GracePeriod></GracePeriod>Informações do período de carência deste TLD. Contém subtags: : Unidade de informações do período de carência : Período de carência para renovação : Excluir período de carência
<IDN></IDN>Se este tld suporta Nomes de Domínio Internacionalizados
<Restrictions></Restrictions>Nome de domínio

Exemplo de Preços de TLD

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=tld_price&currency=USD
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=tld_price&currency=USD
Resposta (Formato 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
      }
    ]
  }
}
 

Comando Listar Domínio

Suporte a multi-thread
Suporte a API Sandbox

Este recurso está disponível apenas no formato XML e JSON:

Parâmetro da requisição de lista de domínios
Explicação
customer_id (optional)Filtrar dados por ID do cliente (somente revendedores podem usar este parâmetro)
count_per_page (optional)Quantas entidades são exibidas por página
page_index (optional)Quais entidades da página você deseja visualizar
sort (optional)Selecione uma das opções a seguir como valor para o parâmetro de classificação:
* Se você não selecionou, usaremos a classificação padrão.
1) Contagem crescente (Padrão)
2) CountDesc
3) NomeAsc
4) NomeDesc
Tag XML de resultado
Explicação
<ListDomainInfoResponse></ListDomainInfoResponse>Nó raiz do documento XML de resposta
<ListDomainInfoHeader></ListDomainInfoHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<ListDomainInfoContent></ListDomainInfoContent>Conteúdo da resposta
<DomainInfoList></DomainInfoList>Lista de informações do domínio
<DomainInfo></DomainInfo>Informações do domínio
<Domain></Domain>Domínio
<Name></Name>Nome de domínio
<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970)
<Registration></Registration>Data de registro do domínio em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970)
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes
<Type></Type>Tipo de configuração do servidor de nomes
<WithAds></WithAds>Com anúncios ou não
<Whois></Whois>Informações Whois
<Registrant></Registrant>Informações do registrante
<ContactId></ContactId>ID do contato
<Admin></Admin>Informações do administrador
<Technical></Technical>Informações técnicas
<Billing></Billing>Informações de cobrança
<Locked></Locked>Bloqueado ou não
<Disabled></Disabled>Status de ativação
<Hold></Hold>Status de Bloqueio do Cliente/Registrador
<Privacy></Privacy>Status de privacidade
<isForSale></isForSale>Status de venda
<RenewOption></RenewOption>Opção de renovação
<Note></Note>Nota
<Folder></Folder>Informações da pasta
<FolderId></FolderId>ID da pasta
<FolderName></FolderName>Nome da pasta

Exemplo de listagem de domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_domain
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_domain
Resposta (Formato 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"
      }
    ]
  }
}
 

Comando Bloquear Domínio

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando lock domain, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de bloqueio de domínio
Explicação
domainO nome de domínio que você deseja bloquear, apenas 1 domínio pode ser inserido por requisição
Tag XML de resultado
Explicação
<LockDomainResponse></LockDomainResponse>Nó raiz do documento XML de respostaDocumento XML
<LockDomainHeader></LockDomainHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Bloqueio de Domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
Resposta (formato XML)
<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
Resposta (Formato JSON)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Pesquisa de Sugestões

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando de Pesquisa de Sugestões comprará o nome de domínio especificado. Este comando está disponível apenas nos formatos XML e JSON. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de Pesquisa de Sugestões
Explicação
domainO domínio que você deseja pesquisar; apenas 1 domínio pode ser inserido por solicitação
tlds (optional)Os TLDs que o resultado da pesquisa contém somente
Tag XML de resultado
Explicação
<SuggestionSearchResponse></SuggestionSearchResponse>Tag da resposta de Pesquisa de Sugestões; é o nó raiz do documento XML de resposta
<SuggestionSearchHeader></SuggestionSearchHeader>Cabeçalho de Pesquisa de Sugestões
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Pesquisa de Sugestões

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Resposta (Formato JSON)
{
  "SuggestionSearchResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Domains": [
      "test1.com",
      "test2.com",
      "test3.net",
      "test4.net"
    ]
  }
}
 

Comando Cancelar Transferência

Suporte a multi-thread
Suporte a API Sandbox

O comando permite cancelar um item de transferência no pedido. Se chamar o comando de cancelar transferência, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Cancelamento de Transferência
Explicação
domainO nome de domínio cuja transferência você deseja cancelar, apenas 1 domínio pode ser inserido por solicitação
order_idO ID do pedido de transferência, você pode obtê-lo em outra API get_transfer_status.
Tag XML de resultado
Explicação
<CancelTransferResponse></CancelTransferResponse>Nó raiz do documento XML de respostaDocumento XML
<CancelTransferHeader></CancelTransferHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Cancelamento de Transferência

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
Resposta (Formato JSON)
{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando para obter o status da transferência

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando get transfer status, os seguintes parâmetros devem ser incluídos:

Parâmetro da Requisição Get Transfer Status
Explicação
domainO nome de domínio para o qual você deseja obter o status de transferência, apenas 1 domínio pode ser inserido por solicitação
transfer_typeO tipo de transferência para o qual você deseja obter o status da transferência (transfer in ou transfer away)
Tag XML de resultado
Explicação
<GetTransferStatusResponse></GetTransferStatusResponse>Nó raiz do documento XML de respostaDocumento XML
<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetTransferStatusContent></GetTransferStatusContent>Conteúdo da resposta
<TransferList></TransferList>Lista de transferências
<Transfer></Transfer>Informações de transferência
<OrderId></OrderId>O ID do pedido
<TransferStatus></TransferStatus>O status de transferência do domínio. Se você recebeu 'none' ou 'approved', pode cancelar a transferência. Se recebeu 'waiting', significa que a transferência já começou. Se recebeu 'auth code needed', significa código de autenticação inválido, você pode usar outra API SET_TRANSFER_AUTH para reenviar o código de autenticação. Existem também outros status, enviaremos um e-mail ou precisará ser verificado por nossos engenheiros.

Exemplo de obtenção do status de transferência

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Resposta (Formato JSON)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

Comando Definir Código de Autenticação de Transferência para Pedido de Transferência

Suporte a multi-thread
Suporte a API Sandbox

O comando que permite atualizar o código de autenticação para processar ordens de transferência. Ao chamar o comando set transfer auth code, os seguintes parâmetros devem ser incluídos:

Parâmetro de Requisição para Definir Código de Autorização de Transferência
Explicação
domainO nome de domínio para o qual você atualiza a autorização de transferência, apenas 1 domínio pode ser inserido por solicitação
auth_codeO auth_code que você deseja reenviar
order_idO ID do pedido de transferência, você pode obtê-lo em outra API get_transfer_status.
Tag XML de resultado
Explicação
<GetTransferStatusResponse></GetTransferStatusResponse>Nó raiz do documento XML de respostaDocumento XML
<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição do código de autorização de transferência

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Resposta (formato XML)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Resposta (Formato JSON)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Autorizar Transferência para Fora

Suporte a multi-thread
Suporte a API Sandbox
Parâmetro da requisição de autorização de transferência de saída
Explicação
domainO nome de domínio para o qual você deseja autorizar a transferência de saída; apenas 1 domínio pode ser inserido por solicitação
order_idO order_id da Dynadot do domínio que você deseja transferir para fora
authorizePara autorizar a transferência de saída, defina como "approve". Para recusar a transferência de saída, defina como "deny".
Tag XML de resultado
Explicação
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>Nó raiz do documento XML de respostaDocumento XML
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<Result></Result>O resultado da autorização de transferência de saída

Exemplo de Autorizar Transferência para Fora

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Resposta (Formato JSON)
{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}
 

Comando para obter código de autorização de transferência

Suporte a multi-thread
Suporte a API Sandbox

Você deve desbloquear seu domínio e sua conta antes de solicitar o código de autorização.

Parâmetro de requisição do código de autorização de transferência
Explicação
domainO nome de domínio para o qual você deseja obter o código de autorização de transferência, apenas 1 domínio pode ser inserido por requisição
new_code (optional)Gerar um novo código de autorização de transferência
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Se você quiser desbloquear o domínio para transferência, defina-o como "1". Se a requisição for processada com sucesso, o domínio será desbloqueado.
Tag XML de resultado
Explicação
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Nó raiz do documento XML de respostaDocumento XML
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<AuthCode></AuthCode>O código de autenticação é usado para iniciar uma transferência de domínio.

Exemplo de Obtenção de Código de Autorização de Transferência

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}
 

Comando para Obter Solicitação de Push de Domínio

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando Get Domain Push Request, você obterá a solicitação de push de domínio. Este comando está disponível apenas nos formatos XML e JSON.

Parâmetro de Solicitação do Comando Obter Solicitação de Push de Domínio
Explicação
N/A Nenhum parâmetro adicional necessário
Tag XML de resultado
Explicação
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>o nó raiz da resposta
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>Cabeçalho da solicitação Get Domain Push
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetDomainPushRequestContent></GetDomainPushRequestContent>conteúdo da resposta
<PushDomain></PushDomain>Transferir Domínio
<PushDomainName></PushDomainName>Push do Nome de Domínio

Exemplo de requisição de push de domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_domain_push_request
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_domain_push_request
Resposta (Formato JSON)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

Comando Definir Solicitação de Push de Domínio

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando Definir Solicitação de Push de Domínio definirá a solicitação de push de domínio. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Solicitação de Push de Domínio
Explicação
domainsO nome de domínio do pedido a ser processado
actionA ação do pedido a ser processado, você pode escolher "accept" ou "decline"
Tag XML de resultado
Explicação
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>o nó raiz da resposta
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>Cabeçalho da solicitação de Definir Push de Domínio
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de solicitação de push de domínio

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Create CN Audit

Suporte a multi-thread
Suporte a API Sandbox

O Comando permite criar uma auditoria CN para um contato. Se estiver chamando o comando create cn audit, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Criação de Auditoria CN
Explicação
contact_idO ID do registro de contato para o qual você deseja iniciar a auditoria, apenas 1 ID de contato pode ser inserido por solicitação
contact_typeTipo de contato, pode ser "Individual" ou "Enterprise"
individual_id_typeTipo de identificação de pessoa física, os valores esperados (descrição do valor) são:
JGZ (carteira de identidade de oficial da República Popular da China)
SFZ (cartão de identidade da República Popular da China)
HZ (Passaporte)
GAJMTX (Autorização de Entrada e Saída para Viajar de e para Hong Kong e Macau)
TWJMTX (Autorizações de viagem para residentes de Taiwan entrarem ou saírem do Continente)
WJLSFZ (Cartão de Identidade de Residente Permanente Estrangeiro da República Popular da China)
GAJZZ (Autorização de residência para Hong Kong, Macau)
TWJZZ (Autorização de residência para residentes de Taiwan)
QT (Outros)
individual_license_idO número da licença do ID da pessoa física
individual_urlDocumento de ID de licença de pessoa física. A URL do arquivo no servidor. Apenas jpg, gif, png, jpeg são permitidos
enterprise_id_type (Mandatory when contact type is "Enterprise")Tipo de ID da empresa, os valores esperados (descrição do valor) são:
ORG (Certificado de Código de Organização)
YYZZ (Licença Comercial)
TYDM (Certificado de Código Unificado de Crédito Social)
BDDM (Designação de Código Militar)
JDDWFW (Licença de Serviço Externo Remunerado Militar)
SYDWFR (Certificado de Pessoa Jurídica de Instituição Pública)
WGCZJG (Formulário de Registro de Escritórios de Representação Residentes de Empresas Estrangeiras)
SHTTFR (Certificado de Registro de Pessoa Jurídica de Organização Social)
ZJCS (Certificado de Registro de Site de Atividade Religiosa)
MBFQY (Certificado de Registro de Entidade Privada Não Empresarial)
JJHFR (Certificado de Registro de Pessoa Jurídica do Fundo)
LSZY (Licença de Exercício de Escritório de Advocacia)
WGZHWH (Certificado de Registro do Centro Cultural Estrangeiro na China)
WLCZJG (Certificado de Registro de Aprovação de Escritório de Representação Residente de Departamentos de Turismo de Governo Estrangeiro)
SFJD (Licença de Perícia Judicial)
JWJG (Certificado de Organização Estrangeira)
SHFWJG (Certificado de Registro de Agência de Serviços Sociais)
MBXXBX (Alvará para Escola Privada)
YLJGZY (Licença de Funcionamento de Instituição Médica)
GZJGZY (Licença de Prática para Organização Notarial)
BJWSXX (Permissão da Escola de Pequim para Filhos de Funcionários de Embaixadas Estrangeiras na China)
QTTYDM (Outros-Certificado para Código Uniforme de Crédito Social)
QT (Outros)
enterprise_license_id (Mandatory when contact type is "Enterprise")O número da licença do documento da empresa
enterprise_url (Mandatory when contact type is "Enterprise")Documento da licença empresarial. A URL do arquivo no servidor. Somente jpg, gif, png, jpeg são permitidos
Tag XML de resultado
Explicação
<CreateCnAuditResponse></CreateCnAuditResponse>Nó raiz do documento XML de resposta
<CreateCnAuditHeader></CreateCnAuditHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Criar exemplo de auditoria Cn

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Obter Status de Auditoria Cn

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando get cn audit status, os seguintes parâmetros devem ser incluídos:

Obter parâmetro de solicitação de status de auditoria Cn
Explicação
contact_idO id do registro de contato para o qual você deseja obter o status de auditoria, apenas 1 contactId pode ser inserido por solicitação
gtldSe você consultar o resultado de auditoria do cnnic-gtld, defina este parâmetro como 1
Tag XML de resultado
Explicação
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>Nó raiz do documento XML de respostaDocumento XML
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<CnAuditStatus></CnAuditStatus>o status de auditoria do registro de auditoria da cnnic. Você pode obter 'processing' ou 'waiting for cnnic' ou 'failed'. Se falhar, enviaremos um e-mail para você.
<FailedReason></FailedReason>Se a auditoria não for aprovada, o motivo da falha será exibido

Exemplo de Obter Status de Auditoria de Cn

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
Resposta (Formato JSON)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

Comando de Criação de Contato

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando de criação de contato, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Criação de Contato
Explicação
organization (optional)As informações da organização
nameNome
emailE-mail
phonenumNúmero de telefone
phoneccCódigo de país do telefone
faxnum (optional)Número de fax
faxcc (optional)Código de país do fax
address1Endereço1
address2 (optional)Endereço 2
cityCidade
state (optional)Estado
zipCódigo postal
countryPaís
Tag XML de resultado
Explicação
<CreateContactResponse></CreateContactResponse>Nó raiz do documento XML de resposta
<CreateContactHeader></CreateContactHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<CreateContactContent></CreateContactContent>ID do novo contato, usado apenas quando o status for "success"

Criar Exemplo de Contato

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

Comando Editar Contato

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando de edição de contato, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de edição de contato
Explicação
contact_idO ID do contato que você deseja editar
organization (optional)As informações da organização
nameNome
emailE-mail
phonenumNúmero de telefone
phoneccCódigo de país do telefone
faxnum (optional)Número de fax
faxcc (optional)Código de país do fax
address1Endereço 1
address2 (optional)Endereço 2
cityCidade
stateEstado
zipCódigo postal
countryPaís
Tag XML de resultado
Explicação
<EditContactResponse></EditContactResponse>Nó raiz do documento XML de resposta
<EditContactHeader></EditContactHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<EditContactContent></EditContactContent>Conteúdo da resposta
<ContactId></ContactId>ID do contato

Exemplo de editar contato

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato CSV)
ok,

success,
,
 

Comando Excluir Contato

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando de exclusão de contato, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Exclusão de Contato
Explicação
contact_idO ID do contato que você deseja excluir; certifique-se de que estejam separados por vírgulas
Tag XML de resultado
Explicação
<DeleteContactResponse></DeleteContactResponse>Nó raiz do documento XML de resposta
<DeleteContactHeader></DeleteContactHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de exclusão de contato

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_contact&contact_id=0
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_contact&contact_id=0
Resposta (Formato JSON)
{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando de lista de contatos

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro de Solicitação de Lista de Contatos
Explicação
N/ANenhum parâmetro adicional necessário
Tag XML de resultado
Explicação
<ContactListResponse></ContactListResponse>Nó raiz do documento XML de resposta
<ContactListHeader></ContactListHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<ContactListContent></ContactListContent>Conteúdo da resposta
<ContactList></ContactList>Lista de contatos
<Contact></Contact>Informações de contato
<ContactId></ContactId>ID do Contato
<Organization></Organization>Organização do contato
<Name></Name>Nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de país do telefone
<PhoneNum></PhoneNum>Número de telefone
<FaxCc></FaxCc>Código de país do fax
<FaxNum></FaxNum>Número de fax
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>Código postal
<Country></Country>País
<GtldVerified></GtldVerified>Status de verificação de gTLD

Exemplo de Lista de Contatos

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=contact_list
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=contact_list
Resposta (Formato 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"
      }
    ]
  }
}
 

Comando de Obtenção de Contato

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro da Solicitação de Obtenção de Contato
Explicação
contact_idID do contato
Tag XML de resultado
Explicação
<GetContactResponse></GetContactResponse>Nó raiz do documento XML de resposta
<GetContactHeader></GetContactHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetContactContent></GetContactContent>Conteúdo da resposta
<Contact></Contact>Informações de contato
<ContactId></ContactId>ID do Contato
<Organization></Organization>Organização do contato
<Name></Name>Nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de país do telefone
<PhoneNum></PhoneNum>Número de telefone
<FaxCc></FaxCc>Código de país do fax
<FaxNum></FaxNum>Número de fax
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>Código postal
<Country></Country>País
<GtldVerified></GtldVerified>Status de verificação de gTLD

Exemplo de Obtenção de Contato

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_contact&contact_id=10000
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_contact&contact_id=10000
Resposta (Formato 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"
    }
  }
}
 

Comando de Definir Configuração de Contato da UE

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set contact eu setting, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de configuração de contato da UE
Explicação
contact_idO ID do contato que você deseja editar
country_of_citizenshipDeve ser um estado membro da UE. Os códigos de país dos estados membros incluem:
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
Tag XML de resultado
Explicação
<SetContactEUSettingResponse></SetContactEUSettingResponse>Nó raiz do documento XML de resposta
<SetContactEUSettingHeader></SetContactEUSettingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Conteúdo da resposta
<ContactId></ContactId>ID do contato

Exemplo de configuração de contato da UE

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Resposta (Formato JSON)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

Comando de Definir Configuração LV do Contato

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set contact lv setting, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Requisição de Configuração de LV do Contato
Explicação
contact_idO ID do contato que você deseja editar
registration_number- Para indivíduos, insira o número de identificação letão.
- Para empresas e outras entidades legais, insira o número de registro emitido pelo Registro de Empresas da Letônia.
vat_number (optional)Número de IVA para entidades jurídicas estrangeiras registradas em países da União Europeia (isto também inclui empresas letãs)
Tag XML de resultado
Explicação
<SetContactLvSettingResponse></SetContactLvSettingResponse>Nó raiz do documento XML de resposta
<SetContactLvSettingHeader></SetContactLvSettingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Conteúdo da resposta
<ContactId></ContactId>ID do contato

Exemplo de configuração de Lv de contato

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Exemplo de definição de configuração de contato LV

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato CSV)
ok,success,0
 

Comando de Definição de Configuração LT do Contato

Suporte a multi-thread
Suporte a API Sandbox

Se você chamar o comando de definição de configuração LT do contato, os seguintes parâmetros devem ser incluídos:

Parâmetro de Requisição do Comando de Definição de Configuração LT do Contato
Explicação
contact_idO ID do contato que você deseja editar
organization_codeVocê só pode definir o código da organização do contato depois que a organização do contato estiver definida.
Tag XML de resultado
Explicação
<SetContactLtSettingResponse></SetContactLtSettingResponse>Nó raiz do documento XML de resposta
<SetContactLtSettingHeader></SetContactLtSettingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<SetContactLtSettingContent></SetContactLtSettingContent>Conteúdo da resposta
<ContactId></ContactId>ID do contato

Exemplo de Definição de Configuração Lt do Contato

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLtSettingResponse>
  <SetContactLtSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLtSettingHeader>
  <SetContactLtSettingContent>
    <ContactId>0</ContactId>
  </SetContactLtSettingContent>
</SetContactLtSettingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetContactLtSettingResponse": {
    "ResponseCode:": "0",
    "Status": "Success",
    "SetContactLtSettingContent": {
      "ContactId": "0"
    }
  }
}
 

Comando para obter servidor de nomes

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando get name server, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação para Obter Servidor de Nomes
Explicação
domainO domínio cujas informações do servidor de nomes você deseja obter, apenas as informações do servidor de nomes de 1 domínio podem ser obtidas por solicitação.
Tag XML de resultado
Explicação
<GetNsResponse></GetNsResponse>Nó raiz do documento XML de resposta
<GetNsHeader></GetNsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<NsContent></NsContent>Conteúdo da resposta
<Host></Host>Nome do host do servidor
<NsName></NsName>Nome do servidor

Exemplo de obtenção de Ns

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
Resposta (Formato JSON)
{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}
 

Comando de Adicionar Servidor de Nomes

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando add name server, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de adicionar servidor de nomes
Explicação
hostO nome do host do servidor de nomes que você deseja adicionar
Tag XML de resultado
Explicação
<AddNsResponse></AddNsResponse>Nó raiz do documento XML de resposta
<AddNsHeader></AddNsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<AddNsContent></AddNsContent>Conteúdo da resposta
<Server></Server>Servidor que você configurou
<Host></Host>Nome do host do novo servidor
<ServerId></ServerId>ID do novo servidor

Exemplo de adição de NS

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
Resposta (Formato JSON)
{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}
 

Comando para Registrar Servidor de Nomes

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando de registro de servidor de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Registro de Servidor de Nomes
Explicação
hostO nome do host do seu próprio servidor de nomes
ipO endereço IP do seu próprio servidor de nomes
Tag XML de resultado
Explicação
<RegisterNsResponse></RegisterNsResponse>Nó raiz do documento XML de resposta
<RegisterNsHeader></RegisterNsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<RegisterNsContent></RegisterNsContent>Conteúdo da resposta
<Server></Server>Tag do servidor
<Host></Host>Nome do host
<ServerId></ServerId>ID do servidor

Exemplo de registro de servidor de nomes

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Resposta (formato XML)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Resposta (Formato JSON)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

Comando de Definir IP do Servidor de Nomes

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set name server IP, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para definir IP do servidor de nomes
Explicação
server_idO ID do servidor de nomes que você deseja definir
ip0 - ip9O endereço IP que você deseja definir no servidor de nomes, 9 IPs podem ser definidos por solicitação e precisam ser separados por vírgulas
Tag XML de resultado
Explicação
<SetNsIpResponse></SetNsIpResponse>Nó raiz do documento XML de resposta
<SetNsIpHeader></SetNsIpHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de IP do servidor de nomes

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Resposta (formato XML)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Resposta (Formato JSON)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando para excluir servidor de nomes

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando de excluir servidor de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de exclusão de servidor de nomes
Explicação
server_idO ID dos servidores de nomes que você deseja excluir, certifique-se de que eles estejam separados por vírgulas
Tag XML de resultado
Explicação
<DeleteNsResponse></DeleteNsResponse>Nó raiz do documento XML de resposta
<DeleteNsHeader></DeleteNsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Excluir NS

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns&server_id=0
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns&server_id=0
Resposta (Formato JSON)
{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando de exclusão de servidor de nomes por domínio

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando delete name server by domain, os seguintes parâmetros devem ser incluídos:

Excluir Servidor de Nomes por Parâmetro de Solicitação de Domínio
Explicação
server_domainNome do servidor de nomes. ex: ns1.testnameserver.com
Tag XML de resultado
Explicação
<DeleteNsResponse></DeleteNsResponse>Nó raiz do documento XML de resposta
<DeleteNsHeader></DeleteNsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Exclusão de Servidor de Nomes por Domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Resposta (formato XML)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Resposta (Formato JSON)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Lista de Servidores

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro de Solicitação de Lista de Servidores
Explicação
N/ANenhum parâmetro adicional necessário
Tag XML de resultado
Explicação
<ServerListResponse></ServerListResponse>Nó raiz do documento XML de resposta
<ServerListHeader></ServerListHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<ServerListContent></ServerListContent>Conteúdo da resposta
<NameServerList></NameServerList>Lista de servidores de nomes
<List></List>
<Server></Server>
<ServerId></ServerId>ID do servidor
<ServerName></ServerName>Nome do servidor
<ServerIp></ServerIp>IP do servidor

Exemplo de lista de servidores

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=server_list
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=server_list
Resposta (Formato 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"
          }
        ]
      }
    ]
  }
}
 

Comando Obter Configurações de NameServer do Domínio

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando get domain nameservers settings, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação para Obter Configurações de Servidor de Nomes do Domínio
Explicação
domainO domínio cuja configuração de servidor de nomes você deseja obter, apenas a configuração de servidor de nomes de 1 domínio pode ser obtida por requisição.
Tag XML de resultado
Explicação
<GetDnsResponse></GetDnsResponse>Nó raiz do documento XML de resposta
<GetDnsHeader></GetDnsHeader>Cabeçalho da resposta
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetDnsContent></GetDnsContent>Conteúdo da resposta
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio
<Type></Type>Tipo de servidor de nomes do domínio

Exemplo de Obtenção das Configurações do Servidor de Nomes do Domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
Resposta (Formato JSON)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

Comando de Informações da Conta

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro de solicitação de informações da conta
Explicação
N/ANenhum parâmetro adicional necessário
Tag XML de resultado
Explicação
<AccountInfoResponse></AccountInfoResponse>Nó raiz do documento XML de resposta
<AccountInfoHeader></AccountInfoHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<AccountInfoContent></AccountInfoContent>Conteúdo da resposta
<AccountInfo></AccountInfo>Informações da conta
<Username></Username>Nome de Usuário
<ForumName></ForumName>Nome do fórum
<Contact></Contact>Informações de contato
<Organization></Organization>Organização
<Organization></Organization>Cabeçalho da resposta
<Name></Name>Seu nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de país do telefone
<PhoneNum></PhoneNum>Número de telefone
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>Código postal
<Country></Country>País
<CustomerSince></CustomerSince>Cliente desde
<AccountLock></AccountLock>Bloqueio de conta
<TotalSpending></TotalSpending>Gasto total
<PriceLevel></PriceLevel>Nível de preço
<AccountBalance></AccountBalance>Saldo da conta
<CustomTimeZone></CustomTimeZone>Fuso horário personalizado
<DefaultSettings></DefaultSettings>Configurações padrão
<DefaultWhois></DefaultWhois>Whois padrão
<DefaultRegistrant></DefaultRegistrant>Registrante padrão
<ContactId></ContactId>ID do Contato
<DefaultAdmin></DefaultAdmin>Administrador padrão
<DefaultTechnical></DefaultTechnical>Técnico padrão
<DefaultBilling></DefaultBilling>Cobrança padrão
<Type></Type>Tipo de servidor de nomes
<WithAds></WithAds>Com anúncios ou não

Exemplo de Informações da Conta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=account_info
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=account_info
Resposta (Formato 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"
        }
      }
    }
  }
}
 

Comando para obter saldo da conta

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro da solicitação de obter saldo da conta
Explicação
N/ANenhum parâmetro adicional necessário
Tag XML de resultado
Explicação
<GetAccountBalanceResponse></GetAccountBalanceResponse>Nó raiz do documento XML de respostaDocumento XML
<GetAccountBalanceHeader></GetAccountBalanceHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Conteúdo da resposta
<Balance></Balance>Saldo da conta

Exemplo de Obter Saldo da Conta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_account_balance
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_account_balance
Resposta (Formato JSON)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

Definir Whois Padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set default Whois, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação Whois padrão
Explicação
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactA informação técnica do domínio
billing_contactAs informações de cobrança do domínio
Tag XML de resultado
Explicação
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Nó raiz do documento XML de resposta
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Whois Padrão

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Servidores de Nomes Padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando de definir servidores de nomes padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro da Solicitação de Definir Servidores de Nomes Padrão
Explicação
ns0 - ns12Os servidores de nomes que você deseja definir
Tag XML de resultado
Explicação
<SetDefaultNsResponse></SetDefaultNsResponse>Tag da resposta de definição de servidores de nomes padrão, é o nó raiz do documento XML de resposta
<SetDefaultNsHeader></SetDefaultNsHeader>Tag do cabeçalho de definir servidores de nomes padrão
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<SetDefaultNsContent></SetDefaultNsContent>Tag do conteúdo de definir servidores de nomes padrão, só é usado quando o status for "success"
<Servers></Servers>As informações dos servidores que você definiu
<Server></Server>Cada servidor
<ServerName></ServerName>Nome do servidor
<ServerId></ServerId>ID do Servidor

Exemplo de Definir Ns Padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Resposta (Formato JSON)
{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

Comando para definir parking padrão

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando de definir estacionamento padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro da Solicitação de Estacionamento Padrão
Explicação
with_ads (optional)Se você não quiser anúncios de terceiros, pode usar este parâmetro com "no", o valor padrão é "yes"
Tag XML de resultado
Explicação
<SetDefaultParkingResponse></SetDefaultParkingResponse>Nó raiz do documento XML de resposta
<SetDefaultParkingHeader></SetDefaultParkingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definir estacionamento padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
Resposta (formato XML)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
Resposta (Formato JSON)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Encaminhamento Padrão

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando de definição de encaminhamento padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para definir encaminhamento padrão
Explicação
forward_urlA URL para a qual você deseja que seu domínio encaminhe. Observe que o parâmetro deve ser codificado para que a chamada da API seja interpretada corretamente.
is_temp (optional)Status de encaminhamento do seu domínio que você deseja, o valor padrão é "temporary", se você quiser encaminhar permanentemente, use este parâmetro com "no"
Tag XML de resultado
Explicação
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Nó raiz do documento XML de resposta
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de encaminhamento padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Resposta (formato XML)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Resposta (Formato JSON)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Stealth Padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set default stealth, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro Padrão de Solicitação Stealth
Explicação
stealth_urlA URL para a qual você deseja que seu domínio encaminhe. Observe que o parâmetro deve ser codificado para que a chamada da API seja interpretada corretamente.
stealth_title (optional)O título da página
Tag XML de resultado
Explicação
<SetDefaultStealthResponse></SetDefaultStealthResponse>Nó raiz do documento XML de resposta
<SetDefaultStealthHeader></SetDefaultStealthHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Stealth Padrão

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Hospedagem Padrão

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set default hosting, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de hospedagem padrão
Explicação
hosting_typeTipo da hospedagem padrão que você deseja; você pode selecionar em "advanced" e "basic"
Tag XML de resultado
Explicação
<SetDefaultHostingResponse></SetDefaultHostingResponse>Nó raiz do documento XML de resposta
<SetDefaultHostingHeader></SetDefaultHostingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definir hospedagem padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
Resposta (formato XML)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
Resposta (Formato JSON)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de DNS Padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando de definir DNS padrão, os seguintes parâmetros devem ser incluídos:

( Este comando está desatualizado e não é recomendado, por favor, use o Comando Definir DNS2 Padrão em vez disso )

Definir Parâmetro de Solicitação DNS Padrão
Explicação
main_record_typeTipo de registro principal
main_recordEspecifique um registro DNS para seu domínio
main_txt (optional)Especifique um registro TXT para seu domínio. Se seu main_record_type for aaaa e você especificou um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.
main_record2Registro principal 2, usado apenas quando "main_record_type" é "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (optional)Registros de subdomínio
sub_record_type0 - sub_record_type99 (optional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (optional)Endereço IP ou host de destino
mx_host0 - mx_host2 (optional)Especifique o host de e-mail do seu domínio, distance0 é a prioridade mais alta.
mx_distance0 - mx_distance2 (optional)Distance0 é a prioridade mais alta
ttl (optional)Tempo de vida
Tag XML de resultado
Explicação
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nó raiz do documento XML de resposta
<SetDefaultDnsHeader></SetDefaultDnsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir DNS Padrão

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando para definir DNS2 padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando de definir DNS padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação para Definir DNS2 Padrão
Explicação
main_record_type0 - main_record_type19Tipo de registro principal
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância MX, tipo de encaminhamento, título de encaminhamento stealth ou alias de e-mail, necessário quando main_record for "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
subdomain0 - subdomain99 (optional)Registros de subdomínio
sub_record_type0 - sub_record_type99 (optional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (optional)Endereço IP do subdomínio ou host de destino
sub_recordx0 - subdo_recordx99Distância Mx, tipo de encaminhamento, título de encaminhamento oculto ou alias de e-mail, necessário quando sub_record_type for "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
ttl (optional)Tempo de vida
Tag XML de resultado
Explicação
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nó raiz do documento XML de resposta
<SetDefaultDnsHeader></SetDefaultDnsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Definir exemplo de DNS2 padrão

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definir Encaminhamento de E-mail Padrão

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set default email forward, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação para Definir Encaminhamento de E-mail Padrão
Explicação
forward_typeTipo de encaminhamento, pode ser "donot": Não encaminhar e-mail, "mx": Entregar e-mail para outro servidor de correio (registro MX), "forward": Entregar e-mail para outro servidor de correio
username0 - username9Nome de usuário, usado apenas quando "forward_type" for "forward"
exist_email0 - exist_email9Endereço de e-mail existente, usado apenas quando "forward_type" for "forward"
mx_host0 - mx_host2Host de e-mail, usado apenas quando "forward_type" for "mx"
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado apenas quando "forward_type" for "mx"
Tag XML de resultado
Explicação
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Nó raiz do documento XML de resposta
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definir encaminhamento de e-mail padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Resposta (formato XML)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Resposta (Formato JSON)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definir Limpar Configuração Padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set clear default setting, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação para limpar configuração padrão
Explicação
serviceO serviço que você deseja limpar; pode ser "forward", "stealth", "email_forwarding", "dns" e "nameservers"
Tag XML de resultado
Explicação
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Nó raiz do documento XML de resposta
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de configuração de limpar padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
Resposta (formato XML)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
Resposta (Formato JSON)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando para definir opção de renovação padrão

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando de definir opção de renovação padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de Definir Opção de Renovação Padrão
Explicação
renew_optionPode ser "donot", "auto", "reset"
Tag XML de resultado
Explicação
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Nó raiz do documento XML de resposta
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Opção de Renovação Padrão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
Resposta (Formato JSON)
{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Criar Pasta

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando create folder, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de criação de pasta
Explicação
folder_nameNome da pasta que você deseja criar
Tag XML de resultado
Explicação
<FolderCreateResponse></FolderCreateResponse>Nó raiz do documento XML de resposta
<FolderCreateHeader></FolderCreateHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<FolderCreateContent></FolderCreateContent>Conteúdo da resposta
<FolderName></FolderName>nome da pasta
<FolderId></FolderId>ID da nova pasta

Exemplo de criação de pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_folder&folder_name=new
Resposta (formato XML)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_folder&folder_name=new
Resposta (Formato JSON)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

Comando de Excluir Pasta

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set Whois, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Exclusão de Pasta
Explicação
folder_idO ID das pastas que você deseja excluir, certifique-se de que estão separadas por vírgulas
Tag XML de resultado
Explicação
<DeleteFolderResponse></DeleteFolderResponse>Nó raiz do documento XML de resposta
<DeleteFolderHeader></DeleteFolderHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Exclusão de Pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
Resposta (Formato JSON)
{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}
 

Comando para definir Whois da pasta

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set folder Whois, os seguintes parâmetros devem ser incluídos:

Parâmetro da Solicitação Whois para Definir Pasta
Explicação
folder_idO ID da pasta que você deseja definir
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactA informação técnica do domínio
billing_contactAs informações de cobrança do domínio
enable (optional)Se você quiser aplicar esta configuração de Whois a domínios futuros que você mover para esta pasta, pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar essa configuração de Whois de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderWhoisResponse></SetFolderWhoisResponse>Nó raiz do documento XML de resposta
<SetFolderWhoisHeader></SetFolderWhoisHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Whois de Configuração de Pasta

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de definir servidores de nomes da pasta

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set folder name servers, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para definir servidores de nome da pasta
Explicação
fold_idO ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
ns0 - ns12Os servidores de nomes para definir que seu domínio use, você pode especificar até 13 servidores de nomes, mas eles já devem estar na sua conta
enable (optional)Se você quiser aplicar esta configuração de servidores de nomes a domínios futuros que mover para esta pasta, pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar a configuração do servidor de nomes de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderNsResponse></SetFolderNsResponse>Tag da resposta do comando set folder name server, é o nó raiz do documento XML de resposta
<SetFolderNsHeader></SetFolderNsHeader>Tag do cabeçalho de resposta do servidor de nomes da pasta definida
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<SetFolderNsContent></SetFolderNsContent>Tag do conteúdo da resposta de definição de servidor de nomes da pasta, só é usada quando o status é "success"
<Servers></Servers>As informações dos servidores que você definiu
<Server></Server>Cada servidor
<ServerName></ServerName>Nome do servidor
<ServerId></ServerId>ID do servidor

Exemplo de Definir NS da Pasta

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

Comando de Definir Estacionamento de Pasta

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando de definir estacionamento de pasta, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de estacionamento de pasta
Explicação
folder_idO ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
with_ads (optional)Se você não quiser anúncios de terceiros, pode usar este parâmetro com "no", o valor padrão é "yes"
enable (optional)Se você quiser aplicar esta configuração de parking a domínios futuros que você mover para esta pasta, pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar a configuração de estacionamento de todos os domínios nesta pasta, pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderParkingResponse></SetFolderParkingResponse>Nó raiz do documento XML de resposta
<SetFolderParkingHeader></SetFolderParkingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Definir Exemplo de Estacionamento de Pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Resposta (formato XML)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Resposta (Formato JSON)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definir Encaminhamento de Pasta

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set folder forwarding, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Solicitação de Encaminhamento de Pasta
Explicação
folder_idO ID da pasta que você deseja definir
forward_urlA URL para a qual você deseja que seu domínio encaminhe. Observe que o parâmetro deve ser codificado para que a chamada da API seja interpretada corretamente.
is_temp (optional)Status de encaminhamento do seu domínio que você deseja, o valor padrão é "temporary", se você quiser encaminhar permanentemente, use este parâmetro com "no"
enable (optional)Se você quiser aplicar esta configuração de encaminhamento a domínios futuros que você mover para esta pasta, pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar a configuração de encaminhamento de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderForwardingResponse></SetFolderForwardingResponse>Nó raiz do documento XML de resposta
<SetFolderForwardingHeader></SetFolderForwardingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Configuração de Encaminhamento de Pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Ocultação de Pasta

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set folder stealth, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação Set Folder Stealth
Explicação
folder_idO ID da pasta que você deseja definir
stealth_urlA URL para a qual você deseja que seu domínio encaminhe. Observe que o parâmetro deve ser codificado para que a chamada da API seja interpretada corretamente.
stealth_title (optional)O título da página
enable (optional)Se você quiser aplicar esta configuração de sigilo a domínios futuros que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar a configuração stealth de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderStealthResponse></SetFolderStealthResponse>Nó raiz do documento XML de resposta
<SetFolderStealthHeader></SetFolderStealthHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Configuração de Pasta Oculta

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Hospedagem da Pasta

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set folder hosting, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de hospedagem de pasta
Explicação
folder_idO ID da pasta que você deseja definir
hosting_typeTipo de hospedagem que você deseja, pode selecionar em "advanced" e "basic"
enable (optional)Se você quiser aplicar esta configuração de hospedagem a domínios futuros que você mover para esta pasta, você pode usar este parâmetro com "yes"
even (optional)Se você quiser sincronizar a configuração de hospedagem de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderHostingResponse></SetFolderHostingResponse>Nó raiz do documento XML de resposta
<SetFolderHostingHeader></SetFolderHostingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de hospedagem de pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Resposta (formato XML)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Resposta (Formato JSON)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando para definir DNS da pasta

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set folder DNS, os seguintes parâmetros devem ser incluídos:

( Este comando está desatualizado e não é recomendado, por favor use o Comando Set Folder DNS2 em vez disso )

Parâmetro da solicitação de Definir DNS da Pasta
Explicação
folder_idO ID da pasta que você deseja definir
main_record_typeTipo de registro principal
main_recordEspecifique um registro DNS para seu domínio
main_recordEspecifique um registro DNS para seu domínio
with_ads (optional)Especifique um registro TXT para seu domínio. Se seu main_record_type for aaaa e você especificou um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.
main_record2Registro principal 2, usado apenas quando "main_record_type" é "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (optional)Registros de subdomínio (opcional)
sub_record_type0 - sub_record_type99 (optional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (optional)Endereço IP ou host de destino
mx_host0 - mx_host2 (optional)Especifique o host de e-mail do seu domínio, distance0 é a prioridade mais alta.
mx_distance0 - mx_distance2 (optional)Distance0 é a prioridade mais alta
ttl (optional)Tempo de vida
enable (optional)Se você quiser aplicar esta configuração de DNS a futuros domínios que você mover para esta pasta, pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar esta configuração de servidor DNS de todos os domínios nesta pasta, pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderDnsResponse></SetFolderDnsResponse>Nó raiz do documento XML de resposta
<SetFolderDnsHeader></SetFolderDnsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de DNS da pasta

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Pasta DNS2

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set folder DNS2, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de definição de pasta DNS2
Explicação
folder_idO ID da pasta que você deseja definir
main_record_type0 - main_record_type19Tipo de registro principal, deve ser "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância MX, tipo de encaminhamento, título de encaminhamento stealth ou alias de e-mail, necessário quando main_record_type for "forward","mx","stealth","email"
subdomain0 - subdomain99 (optional)Registros de subdomínio (opcional)
sub_record_type0 - sub_record_type99 (optional)Tipo de registros de subdomínio, deve ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (optional)Endereço IP ou host de destino
sub_recordx0 - sub_recordx99 (optional)Distância MX, tipo de encaminhamento, título de encaminhamento stealth ou alias de e-mail, necessário quando sub_record_type for "forward","mx","stealth","email"
ttl (optional)Tempo de vida
enable (optional)Se você quiser aplicar esta configuração de DNS a futuros domínios que você mover para esta pasta, pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar esta configuração de servidor DNS de todos os domínios nesta pasta, pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderDnsResponse></SetFolderDnsResponse>Nó raiz do documento XML de resposta
<SetFolderDnsHeader></SetFolderDnsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Pasta Dns2

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetFolderDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando de Encaminhamento de E-mail de Configuração de Pasta

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set folder email forward, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de definir encaminhamento de e-mail da pasta
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que estejam separados por vírgulas
folder_idID da pasta que você deseja definir
forward_typeTipo de encaminhamento, pode ser "donot": Não encaminhar e-mail, "mx": Entregar e-mail para outro servidor de correio (registro MX), "forward": Entregar e-mail para outro servidor de correio
username0 - username9Nome de usuário, usado apenas quando "forward_type" for "forward"
exist_email0 - exist_email9Endereço de e-mail existente, usado apenas quando "forward_type" for "forward"
mx_host0 - mx_host2Host de e-mail, usado apenas quando "forward_type" for "mx"
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado apenas quando "forward_type" for "mx"
enable (optional)Se você quiser aplicar esta configuração a domínios futuros que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar esta configuração de todos os domínios nesta pasta, pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Nó raiz do documento XML de resposta
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição de encaminhamento de e-mail da pasta

Solicitar (formato 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]
Solicitação de Sandbox (formato 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]
Resposta (formato XML)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Solicitar (Formato 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]
Solicitação de Sandbox (Formato 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]
Resposta (Formato JSON)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Configuração de Limpeza de Pasta

Suporte a multi-thread
Suporte a API Sandbox

Se chamar o comando set clear folder setting, os seguintes parâmetros devem ser incluídos:

Parâmetro de Requisição para Definir Configuração de Limpeza de Pasta
Explicação
folder_idO ID da pasta que você deseja definir
serviceO serviço que você deseja limpar; pode ser "forward", "stealth", "email_forwarding", "dns" e "nameservers"
Tag XML de resultado
Explicação
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nó raiz do documento XML de resposta
<SetClearFolderSettingHeader></SetClearFolderSettingHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de configuração para definir/limpar pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Resposta (formato XML)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Resposta (Formato JSON)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Definir Nome da Pasta

Suporte a multi-thread
Suporte a API Sandbox

Se estiver chamando o comando set folder name, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para definir o nome da pasta
Explicação
folder_idID da pasta que você deseja definir
folder_nameNome da nova pasta
Tag XML de resultado
Explicação
<SetFolderNameResponse></SetFolderNameResponse>Nó raiz do documento XML de resposta
<SetFolderNameHeader></SetFolderNameHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Nome da Pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
Resposta (formato XML)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
Resposta (Formato JSON)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Set Folder Renew Option

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando set folder renew option, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de Definir Opção de Renovação da Pasta
Explicação
folder_idO ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
renew_optionA opção de renovação que você deseja definir para a pasta; pode ser "donot", "auto" ou "reset"
enable (optional)Se você quiser aplicar esta configuração de renovação a domínios futuros que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (optional)Se você quiser sincronizar a configuração de renovação de todos os domínios nesta pasta, pode usar este parâmetro com "yes"
Tag XML de resultado
Explicação
<Response></Response>Nó raiz do documento XML de resposta
<ResponseHeader></ResponseHeader>Cabeçalho de resposta
<ResponseCode></ResponseCode>Código de resposta, "0" para sucesso, "-1" para falha
<Error></Error>Informação de erro, usada apenas quando o código de resposta é "-1"

Exemplo de definir opção de renovação da pasta

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Resposta (formato XML)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Resposta (Formato JSON)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de listagem de pastas

Suporte a multi-thread
Suporte a API Sandbox

Este comando está disponível apenas nos formatos XML e JSON:

Parâmetro de requisição da lista de pastas
Explicação
N/ANenhum parâmetro adicional necessário
<FolderListResponse></FolderListResponse>Nó raiz do documento XML de resposta
<FolderListHeader></FolderListHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<FolderListContent></FolderListContent>Conteúdo da resposta
<FolderList></FolderList>Lista de pastas
<List></List>
<Folder></Folder>
<FolderId></FolderId>ID da pasta
<FolderName></FolderName>Nome da pasta
<DefaultWhois></DefaultWhois>Whois padrão
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Status de ativação padrão do Whois
<DefaultRegistrant></DefaultRegistrant>Registrante padrão
<ContactId></ContactId>ID do contato
<DefaultAdmin></DefaultAdmin>Administrador padrão
<DefaultTechnical></DefaultTechnical>Informações técnicas padrão
<DefaultBilling></DefaultBilling>Informações de cobrança padrão
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Status de ativação do servidor de nomes padrão
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes
<Type></Type>Tipo de servidor de nomes
<WithAds></WithAds>Com anúncios ou não
<DefaultRenewOption></DefaultRenewOption>Opção de renovação padrão
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Status de habilitação da opção de renovação padrão
<RenewOption></RenewOption>Opção de renovação
<DefaultTransferLock></DefaultTransferLock>Bloqueio de transferência padrão
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Status de ativação do bloqueio de transferência padrão
<LockStatus></LockStatus>Status de bloqueio

Exemplo de lista de pastas

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=folder_list
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=folder_list
Resposta (Formato 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"
        }
      }
    ]
  }
}
 

Adicionar comando de solicitação de backorder

Suporte a multi-thread
API Sandbox não suportado

Ao chamar o comando add backorder request, os seguintes parâmetros devem ser incluídos:

Adicionar Parâmetro de Solicitação de Backorder
Explicação
domainO(s) domínio(s) que você deseja adicionar e concorda em pagar se a Dynadot capturá-lo, 100 domínios podem ser adicionados por solicitação, eles devem ser separados por vírgulas
Tag XML de resultado
Explicação
<AddBackorderRequestResponse></AddBackorderRequestResponse>Nó raiz do documento XML de resposta
<AddBackorderRequestHeader></AddBackorderRequestHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de solicitação de backorder

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Resposta (formato XML)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Resposta (Formato JSON)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Excluir Solicitação de Backorder

Suporte a multi-thread
API Sandbox não suportado

Se chamar o comando de solicitação para excluir backorder, os seguintes parâmetros devem ser incluídos:

Parâmetro da solicitação de Exclusão de Pedido em Espera
Explicação
domainO(s) domínio(s) que você deseja remover da sua lista de pedidos de backorder, 100 domínios podem ser removidos por solicitação, eles devem ser separados por vírgulas
Tag XML de resultado
Explicação
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Nó raiz do documento XML de resposta
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Solicitação de Exclusão de Backorder

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
Resposta (formato XML)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
Resposta (Formato JSON)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Lista de Pedidos de Backorder

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando de lista de solicitações de backorder retornará uma lista de solicitações de backorder da conta especificada. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação da lista de pedidos de backorder
Explicação
start_dateData de início do drop do leilão que você deseja solicitar, yyyy-mm-dd, como 2015-05-05
end_dateData final de drop do leilão que você deseja solicitar, yyyy-mm-dd, como 2015-05-05
Tag XML de resultado
Explicação
<BackorderRequestListResponse></BackorderRequestListResponse>Nó raiz do documento XML de resposta
<BackorderRequestListHeader></BackorderRequestListHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<BackorderRequestListContent></BackorderRequestListContent>Conteúdo da resposta
<BackorderRequestList></BackorderRequestList>Lista de Solicitações de Backorder
<BackorderRequest></BackorderRequest>Solicitação de backorder
<Domain></Domain>Domínio na sua lista
<CutoffTime></CutoffTime>Data limite para excluir uma solicitação em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970)
<BackorderRequestStatus></BackorderRequestStatus>Status no processo de drop catching

Exemplo de Lista de Solicitação de Backorder

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Resposta (Formato 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"
      }
    ]
  }
}
Solicitar (formato CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Solicitação de Sandbox (formato CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Resposta (formato CSV)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
 

Comando Obter Leilões Abertos

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando get open auctions retornará uma lista de leilões em andamento. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação Get Open Auctions
Explicação
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
type (optional)O tipo de leilão que você deseja ver, deve ser "expired", "user", "backorder" ou "registry_expired", "registrar", se você quiser obter mais de um tipo de leilão, pode usar "," para separar cada tipo de leilão
count_per_pageQuantas entidades são exibidas por página (máximo 1000)
page_index Quais entidades da página você deseja visualizar
has_bids (optional)Quando este parâmetro é verdadeiro, ele retornará apenas leilões que receberam lances. Se for falso, retorna leilões sem lances. Se não for passado, retorna todos os leilões.
Tag XML de resultado
Explicação
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Tag da resposta de obter leilões abertos, é o nó raiz do documento XML de resposta
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Obter cabeçalho de leilões abertos
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "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 do leilão
<Domain></Domain>Nome de domínio do leilão
<BidPrice></BidPrice>Preço atual do lance do leilão
<BidPriceCurrency></BidPriceCurrency>Moeda do preço do lance
<Bids></Bids>Número de lances do leilão
<EndTime></EndTime>Hora de término do leilão
<EndTimestamp></EndTimestamp>Data de término do leilão em tempo Unix (milissegundos desde a meia-noite UTC de 1 de janeiro de 1970)
<Revenue></Revenue>Receita do leilão
<RevenueCurrency></RevenueCurrency>Moeda da receita
<Visitors></Visitors>Visitantes do domínio
<Links></Links>Links de entrada do domínio
<Age></Age>Idade do domínio

Exemplo de Obter Leilões Abertos

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Requisição (formato csv)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions¤cy=usd&type=expired&count_per_page=20&page_index=1

Resposta

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

Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato 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": "-"
        }
        ...
    ]
}
 

Comando de Obter Detalhes do Leilão

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando get auction details retornará os detalhes do leilão especificado. Este comando está disponível apenas nos formatos XML e JSON. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obter detalhes do leilão
Explicação
domainO nome de domínio do leilão, IDN (Nome de Domínio Internacional) deve usar punycode, como "xn--wkccg.com". Você pode obter mais de um leilão, cada domínio deve ser separado por ","
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Tag da resposta de obter detalhes do leilão, é o nó raiz do documento XML de resposta
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho de obtenção de detalhes do leilão de backorder
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>ID de status do leilão : '0' para Em Andamento, '1' para Cancelado pelo Usuário, '2' para Cancelado pelo Administrador, '3' para Cancelado pela Renovação, '4' para Completo, '5' para Cancelado por Transferência para Fora
<AuctionStatus></AuctionStatus>Status do leilão
<UserIsHighBid></UserIsHighBid>Se o usuário tiver o lance mais alto
<YourCurrentBid></YourCurrentBid>Seu preço de lance atual para o leilão especificado. Se você não deu um lance, ele será '-1'
<YourProxyBid></YourProxyBid>Seu lance proxy para o leilão especificado. Se você não tiver feito um lance, será '-1'
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de domínio do leilão
<BidPrice></BidPrice>Preço atual do lance do leilão
<BidPriceCurrency></BidPriceCurrency>Moeda do preço do lance
<Bids></Bids>Número de lances do leilão
<EndTime></EndTime>Hora de término do leilão
<EndTimestamp></EndTimestamp>Data de término do leilão em tempo Unix (milissegundos desde a meia-noite UTC de 1 de janeiro de 1970)
<IsPremium></IsPremium>Se é um domínio premium
<RenewalPrice></RenewalPrice>Preço de renovação

Exemplo de Obter Detalhes do Leilão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Resposta (Formato 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": []
    }
  ]
}
 

Comando para obter lances do leilão

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando get auction bids retornará sua lista de lances dos quais você participou. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Obtenção de Lances de Leilão
Explicação
currency (optional)A moeda do seu lance, deve ser "usd", "eur" ou "cny", a moeda padrão é Dólares Americanos
count_per_pageQuantas entidades são exibidas por página (máximo 50)
page_index Quais entidades da página você deseja visualizar
Tag XML de resultado
Explicação
<GetAuctionBidsResponse></GetAuctionBidsResponse>Tag da resposta de get auction bids, é o nó raiz do documento XML de resposta
<GetAuctionBidsHeader></GetAuctionBidsHeader>Cabeçalho de get auction bids
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> Lista de lances
<Bid></Bid> Item de lance
<BidId></BidId> ID do lance
<AuctionId></AuctionId> ID do leilão
<AccountId></AccountId>ID da conta
<Domain></Domain>Nome de domínio do leilão
<DomainUtf></DomainUtf>Nome utf do domínio do leilão
<AuctionType></AuctionType>Tipo de leilão
<IsIdn></IsIdn>Se este domínio for um Nome de Domínio Internacionalizado
<CurrentBid></CurrentBid>Preço atual do lance para o leilão
<YourStatus></YourStatus>Seu status de lance para o leilão
<ProxyBid></ProxyBid>Seu preço de lance proxy para o leilão
<ActiveBidders></ActiveBidders>A quantidade de licitantes que participam deste leilão
<TimeLeft></TimeLeft>o tempo restante para o leilão
<EndTime></EndTime>O horário de término do leilão
<EndTimestamp></EndTimestamp>O timestamp de término do leilão

Exemplo de Obtenção de Lances de Leilão

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Solicitação de Sandbox (Formato 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
Resposta (Formato 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
        }
        ...
    ]
}
 

Comando de Lance em Leilão

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando place auction bid fará um lance para o leilão especificado. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de Dar Lance em Leilão
Explicação
domainO nome de domínio do leilão, IDN (Nome de Domínio Internacionalizado) deve usar punycode, como "xn--wkccg.com"
bid_amountO valor do seu lance para o leilão, a moeda padrão é Dólares americanos, você também pode especificá-la pelo parâmetro currency abaixo
currency (optional)A moeda do seu lance, deve ser "usd", "eur" ou "cny", a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Tag da resposta de lance de leilão de posição, é o nó raiz do documento XML de resposta
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Cabeçalho para dar lance em leilão
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de domínio

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
Requisição (formato csv)

https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd

Resposta

ok,success

Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Solicitação de Sandbox (Formato 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
Resposta (Formato 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
            }
            ...        ]
    }
}
 

Comando Obter Leilões Fechados

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando get closed auctions retornará uma lista de leilões encerrados da conta especificada. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de obtenção de leilões encerrados
Explicação
start_dateO carimbo de data/hora que indica o início do horário de encerramento do leilão, yyyy-mm-dd, como 2015-05-05
end_dateO timestamp que indica o fim do horário de término do leilão, yyyy-mm-dd, como 2015-05-05
currency (optional)A moeda do seu lance, deve ser "usd", "eur" ou "cny", a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Tag da resposta de leilões fechados, é o nó raiz do documento XML de resposta
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Obter cabeçalho de leilões fechados
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "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 do leilão
<Domain></Domain>Nome de domínio do leilão
<AuctionStatusId></AuctionStatusId>ID de status do leilão, '0' para Em Andamento e '1' para Fechado pelo Usuário, '2' para Fechado pelo Administrador, '3' para Fechado por Renovação, '4' para Fechado por Tempo Esgotado, '5' para Fechado por Transferência para Fora
<AuctionStatus></AuctionStatus>Status do leilão
<BidPrice></BidPrice>Preço atual do lance do leilão
<BidPriceCurrency></BidPriceCurrency>Moeda do preço do lance
<Bids></Bids>Número de lances do leilão
<AuctionWonStatus></AuctionWonStatus>Se o usuário venceu este leilão
<YourHighBid></YourHighBid>Seu lance mais alto para este leilão
<YourProxyBid></YourProxyBid>Seu lance proxy para este leilão

Exemplo de obter leilões encerrados

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Resposta (Formato 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"
      }
    ]
  }
}
Solicitar (formato CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Solicitação de Sandbox (formato CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Resposta (formato 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
 

Comando Obter Leilões Abertos de Backorder

Suporte a multi-thread
API Sandbox não suportado

Ao chamar o comando get open backorder auctions, será retornada uma lista de leilões de backorder em andamento. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obter leilões de backorder abertos
Explicação
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Tag da resposta de get open backorder auctions, é o nó raiz do documento XML de resposta
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Obter cabeçalho de leilões de backorder abertos
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "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 do leilão
<Domain></Domain>Nome de domínio do leilão
<BidPrice></BidPrice>Preço atual do lance do leilão
<BidPriceCurrency></BidPriceCurrency>Moeda do preço do lance
<Bids></Bids>Número de lances do leilão
<EndTime></EndTime>Hora de término do leilão
<EndTimestamp></EndTimestamp>Data de término do leilão em tempo Unix (milissegundos desde a meia-noite UTC de 1 de janeiro de 1970)

Exemplo de Obter Leilões de Backorder Abertos

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_backorder_auctions&currency=usd
Resposta (formato 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>
Requisição (formato csv)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions¤cy=usd

Resposta

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

 

Comando para Obter Detalhes do Leilão de Backorder

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando get backorder auction details retornará os detalhes do leilão especificado. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obter detalhes do leilão
Explicação
domainO nome de domínio do leilão de backorder, IDN (Nome de Domínio Internacional) deve usar punycode, como "xn--wkccg.com"
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Tag da resposta de obter detalhes do leilão, é o nó raiz do documento XML de resposta
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho de obter detalhes do leilão
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>ID de status do leilão, '0' para Em Andamento e '1' para Fechado pelo Usuário, '2' para Fechado pelo Administrador, '3' para Fechado por Renovação, '4' para Fechado por Tempo Esgotado, '5' para Fechado por Transferência para Fora
<AuctionStatus></AuctionStatus>Status do leilão
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de domínio do leilão
<BidPrice></BidPrice>Preço atual do lance do leilão
<BidPriceCurrency></BidPriceCurrency>Moeda do preço do lance
<Bids></Bids>Número de lances do leilão
<EndTime></EndTime>Hora de término do leilão
<EndTimestamp></EndTimestamp>Data de término do leilão em tempo Unix (milissegundos desde a meia-noite UTC de 1 de janeiro de 1970)
<Revenue></Revenue>Receita do leilão
<RevenueCurrency></RevenueCurrency>Moeda da receita
<Visitors></Visitors>Visitantes do domínio
<Links></Links>Links de entrada do domínio
<Age></Age>Idade do domínio
<UserIsHighBid></UserIsHighBid>Se o usuário tiver o lance mais alto
<YourCurrentBid></YourCurrentBid>Seu preço de lance atual para o leilão especificado. Se você não deu um lance, ele será '-1'
<YourProxyBid></YourProxyBid>Seu lance proxy para o leilão especificado. Se você não tiver feito um lance, será '-1'

Exemplo de Obter Detalhes do Leilão de Backorder

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Resposta (Formato 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"
      }
    }
  }
}
 

Comando para Dar Lance em Leilão de Backorder

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando place backorder auction bid fará um lance para o leilão de backorder especificado. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de lance em leilão de backorder
Explicação
domainO nome de domínio do leilão, IDN (Nome de Domínio Internacionalizado) deve usar punycode, como "xn--wkccg.com"
bid_amountO valor do seu lance para o leilão, a moeda padrão é Dólares americanos, você também pode especificá-la pelo parâmetro currency abaixo
currency (optional)A moeda do seu lance, deve ser "usd", "eur" ou "cny", a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Tag da resposta de lance de leilão de posição, é o nó raiz do documento XML de resposta
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Cabeçalho para dar lance em leilão
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Lance em Leilão de Backorder

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
Solicitar (formato CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Solicitação de Sandbox (formato 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
Resposta (formato CSV)
ok,success
 

Comando para Obter Leilões Fechados de Backorder

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando get closed backorder auctions retornará uma lista de leilões de backorder fechados da conta especificada. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação Get Closed Backorder Auctions
Explicação
start_dateData de início do leilão, yyyy-mm-dd, como 2015-05-05
end_dateData de término do leilão, yyyy-mm-dd, como 2015-05-05
currency (optional)A moeda do seu lance, deve ser "usd", "eur" ou "cny", a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Tag da resposta de leilões fechados, é o nó raiz do documento XML de resposta
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Obter cabeçalho de leilões fechados
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "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>Seu lance mais alto para este leilão
<YourProxyBid></YourProxyBid>Seu lance proxy para este leilão
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de domínio do leilão
<AuctionStatusId></AuctionStatusId>ID de status do leilão, '0' para Em Andamento e '1' para Fechado pelo Usuário, '2' para Fechado pelo Administrador, '3' para Fechado por Renovação, '4' para Fechado por Tempo Esgotado, '5' para Fechado por Transferência para Fora
<AuctionStatus></AuctionStatus>Status do leilão
<BidPrice></BidPrice>Preço atual do lance do leilão
<BidPriceCurrency></BidPriceCurrency>Moeda do preço do lance
<Bids></Bids>Número de lances do leilão

Exemplo de Obter Leilões de Backorder Fechados

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Solicitação de Sandbox (Formato 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
Resposta (Formato 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"
      }
    ]
  }
}
Solicitar (formato CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Solicitação de Sandbox (formato 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
Resposta (formato 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
 

Comando para Obter Domínios Closeout Expirados

Suporte a multi-thread
API Sandbox não suportado

Chamar o Comando Get Expired Closeout Domains obterá Domínios Expirados de Closeout. Este comando está disponível apenas em formato XML e JSON. Se chamar este comando, os seguintes parâmetros deverão ser incluídos:

Parâmetro de Solicitação de Obter Domínios Expirados de Closeout
Explicação
currency(optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
domain(optional)Adicione este parâmetro se você quiser consultar um domínio em closeout
count_per_page (optional)Quantas entidades são exibidas por página
page_index (optional)Quais entidades da página você deseja visualizar
Tag XML de resultado
Explicação
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Tag da resposta de Obter Domínios Expirados em Closeout, é o nó raiz do documento XML de resposta
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Obter cabeçalho de domínios expirados em Closeout
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>Item de Liquidação
<DomainName></DomainName>O nome de domínio
<DomainNameUtf></DomainNameUtf>O nome de domínio está em formato utf
<CurrentPrice></CurrentPrice>preço atual
<isIdn></isIdn>Se é o nome de domínio idn
<EndTimeStamp></EndTimeStamp>Data de término do leilão em tempo Unix (milissegundos desde a meia-noite UTC de 1 de janeiro de 1970)
<RenewalPrice></RenewalPrice>Preço de renovação
<ExpiredRevenue></ExpiredRevenue>Receita de closeout
<DynaAppraisal></DynaAppraisal>DynaAppraisal
<InboundLinks></InboundLinks>Links de entrada do domínio
<MonthlyVisitors></MonthlyVisitors>Visitantes do domínio
<Currency></Currency>Moeda

Exemplo de obtenção de domínios expirados em liquidação

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Resposta (Formato 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"
        }
      }
    ]
  }
}
 

Comando de Compra de Domínio Expirado em Closeout

Suporte a multi-thread
API Sandbox não suportado

Chamar o comando Buy Expired Closeout Domain comprará o nome de domínio especificado. Este comando está disponível apenas nos formatos XML e JSON. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Compra de Domínio Expirado em Liquidação
Explicação
domainO domínio que você deseja comprar, apenas 1 domínio pode ser inserido por solicitação
currency(optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Tag da resposta de Buy Expired Closeout Domain, é o nó raiz do documento XML de resposta
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Cabeçalho de compra de domínio expirado em liquidação
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Compra de Domínio Expirado em Closeout

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Resposta (Formato JSON)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Comando de Obter Listagens

Suporte a multi-thread
API Sandbox não suportado

Ao chamar o comando get listings, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Listagens
Explicação
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
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)Se você quiser obter listagens de outros registradores, deve ser "yes", o padrão é "no"
count_per_pageQuantas entidades são exibidas por página. (máximo 20000)
page_indexEntidades de qual página você deseja visualizar.
Tag XML de resultado
Explicação
<GetListingsResponse></GetListingsResponse>Nó raiz do documento XML de respostaDocumento XML
<GetListingsHeader></GetListingsHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetListingsContent></GetListingsContent>Conteúdo da listagem
<Listing></Listing>Conteúdo do item de listagem
<ListingId></ListingId>ID do anúncio
<Domain></Domain>Nome de domínio
<Price></Price>Preço
<InBoundLinks></InBoundLinks>Contagem de links de entrada
<Age></Age>Idade

Exemplo de obtenção de listagens

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Resposta (Formato 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"
      }
    ]
  }
}
 

Comando para obter item da listagem

Suporte a multi-thread
API Sandbox não suportado

Ao chamar o comando get listing item, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obter item de listagem
Explicação
domainO nome de domínio cujos detalhes você deseja obter, apenas 1 domínio pode ser inserido por solicitação
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; a moeda padrão é Dólares Americanos
Tag XML de resultado
Explicação
<GetListingItemResponse></GetListingItemResponse>Nó raiz do documento XML de respostaDocumento XML
<GetListingItemHeader></GetListingItemHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetListingsItemContent></GetListingsItemContent>Conteúdo da listagem
<Listing></Listing>Conteúdo do item de listagem
<ListingId></ListingId>ID do anúncio
<Domain></Domain>Nome de domínio
<Price></Price>Preço
<InBoundLinks></InBoundLinks>Contagem de links de entrada
<Age></Age>Idade

Obter Exemplo de Item de Listagem

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
Resposta (Formato 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"
    }
  }
}
 

Comando Comprar Agora

Suporte a multi-thread
API Sandbox não suportado

Ao chamar o comando buy it now, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação Buy It Now
Explicação
domainO domínio que você deseja comprar, apenas 1 domínio pode ser inserido por solicitação
currency (optional)A moeda do resultado retornado deve ser "usd", "eur" ou "cny"; se nenhuma moeda for informada, a moeda padrão da conta será aplicada
price_to_verify (optional)O preço esperado de buy_it_now a ser verificado antes da compra. Se o preço real do anúncio não corresponder a este valor, a solicitação falhará.
Tag XML de resultado
Explicação
<BuyItNowResponse></BuyItNowResponse>Nó raiz do documento XML de respostaDocumento XML
<BuyItNowHeader></BuyItNowHeader>Cabeçalho da resposta
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<Message></Message>Deve ser "domain order created", usado apenas quando o status for "success".

Exemplo de Comprar Agora

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
  <BuyItNowContent>
    <OrderId>1</OrderId>
  </BuyItNowContent>
</BuyItNowResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Resposta (Formato JSON)
{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderId": 1
  }
}
 

Comando Adicionar Novo Lead

Suporte a multi-thread
API Sandbox não suportado

Chamar o Comando Adicionar Novo Lead importará seus próprios leads para o sistema da Dynadot com uma taxa de comissão de 5%.

Observação: O domínio será desbloqueado para permitir que o comprador finalize a compra imediatamente após a aceitação.

Este comando está disponível apenas nos formatos XML e JSON.Se você chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação Adicionar Novo Lead
Explicação
domain_nameO nome de domínio para o qual você deseja adicionar lead, apenas 1 domínio pode ser inserido por solicitação
lead_typeo tipo de lead para o qual você deseja definir o lead. Os valores aceitáveis são "buy_now", "make_offer"
priceo preço que você deseja definir para o lead
buyer_nameo nome dos compradores
buyer_emailo e-mail dos compradores
Tag XML de resultado
Explicação
<AddNewLeadResponse></AddNewLeadResponse>o nó raiz da resposta
<AddNewLeadHeader></AddNewLeadHeader>Cabeçalho Adicionar Novo Lead
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Adicionar Novo Lead

Solicitar (formato 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]
Solicitação de Sandbox (formato 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]
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<AddNewLeadResponse>
  <AddNewLeadHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AddNewLeadHeader>
</AddNewLeadResponse>
Solicitar (Formato 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]
Solicitação de Sandbox (Formato 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]
Resposta (Formato JSON)
{
  "AddNewLeadResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Comando Colocar à Venda

Suporte a multi-thread
API Sandbox não suportado

Este comando suporta multi-thread.

Chamar o Comando Definir Para Venda colocará seu domínio à venda no Mercado de Domínios. Este comando só está disponível nos formatos XML e JSON.Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação Para Venda
Explicação
domainsO domínio que você deseja listar para venda no Mercado de Domínios; apenas 1 domínio pode ser inserido por solicitação
for_sale_typeVocê pode escolher um valor da lista a seguir para representar seu tipo de venda:
> mercado:
Liste seu domínio para venda no Mercado de Domínios. Novos anúncios de domínio serão definidos para a categoria, subcategoria e preço inseridos abaixo. Se um preço real for definido, o domínio ficará disponível para compra imediata e será enviado por push ao comprador. Mais informações sobre o processo de venda de domínio >

> não_para_venda:
cancelar listagem
listing_type (optional)Você pode escolher um valor da lista a seguir para representar seu tipo de venda no mercado: (obrigatório se for_sale_type for marketplace)
> buy_now
Definir um preço fixo tornará o domínio disponível para compra imediata e o enviará ao comprador.
Nota: Para domínio no período de carência de adição, se houver uma venda, ele pode não ser mais excluído por carência. Mais informações sobre Exclusão em período de carência

> make_offer
Você pode definir um preço mínimo de oferta ou deixar em branco para permitir qualquer valor de oferta.
Nota: Para domínio no período de carência de adição, se houver uma venda, ele pode não ser mais excluído por carência. Mais informações sobre Exclusão em período de carência

> buy_now_and_make_offer Definir um preço fixo fará com que o domínio fique disponível para compra imediata e o enviará por push para o comprador.
Você pode definir um preço mínimo de oferta ou deixar em branco para permitir qualquer valor de oferta.
Nota: Para domínio no período de carência de adição, se houver uma venda, ele pode não ser mais excluído por carência. Mais informações sobre Exclusão em período de carência
price (optional)o preço pelo qual você quer vender seu domínio. (obrigatório se for_sale_type for marketplace)
minimum_offer (optional)a oferta mínima que você aceitará pelo seu domínio. (obrigatória se for_sale_type for marketplace)
installment (optional)É permitido pagamento parcelado. Se você quiser habilitar o pagamento parcelado, defina-o como "Yes"
maximum_installments (optional)O número máximo de parcelas permitido é usado apenas quando installment for "true"
Você pode escolher um valor de 2 a 12 para representar o número máximo de meses para o pagamento parcelado
category (optional)escolha uma categoria para o seu domínio, Você pode consultar a tabela de comparação de Categoria e Subcategoria abaixo para preenchimento opcional.
Sub-category (optional)escolha uma subcategoria para o seu domínio, Você pode consultar a tabela de comparação de Categoria e Subcategoria abaixo para fazer a seleção.
Observação: o valor do seu parâmetro precisa ser o número correspondente à subcategoria.
CategoriaSubcategoria
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)Descrição do seu domínio
Tag XML de resultado
Explicação
<SetForSaleResponse></SetForSaleResponse>o nó raiz da resposta
<SetForSaleHeader></SetForSaleHeader>Definir cabeçalho Para Venda
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir para Venda

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato JSON)
{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}
 

Comando de Lista de Domínios para Transferência de Saída

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando de Lista de Domínios de Transferência de Saída obterá a lista de domínios em processamento de transferência de saída. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando

Parâmetro de Solicitação da Lista de Domínios de Transferência de Saída
Explicação
Tag XML de resultado
Explicação
<TransferOutDomainListResponse></TransferOutDomainListResponse>o nó raiz da resposta
<TransferOutDomainListHeader></TransferOutDomainListHeader>Cabeçalho da lista de domínios de transferência de saída
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<TransferOutDomainListContent></TransferOutDomainListContent>Cabeçalho da lista de domínios de transferência de saída
<TransferOutDomainList></TransferOutDomainList>A lista de domínios de transferência de saída
<Domain></Domain>O nome de domínio
<OrderId></OrderId>O ID do pedido do domínio de transferência de saída
<ItemStatus></ItemStatus>O status do domínio de transferência de saída

Exemplo de lista de domínios de transferência de saída

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer_domain_list
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer_domain_list
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer_domain_list
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer_domain_list
Resposta (Formato JSON)
{
  "TransferOutDomainListResponse": {
    "ResponseCode": 200,
    "Status": "success",
    "TransferOutDomainList": [
      {
        "orderId": 1,
        "domain": "domain1.com",
        "itemStatus": "Pending"
      }
    ]
  }
}
 

Comando de Definir Ação de Confirmação da Afternic

Suporte a multi-thread
API Sandbox não suportado

Chamar o Comando de Definir Ação de Confirmação do Afternic definirá o domínio para aprovar ou reprovar a transferência rápida no Afternic. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de Definir Ação de Confirmação do Afternic
Explicação
domainO domínio para o qual você deseja definir a ação de confirmação de transferência rápida da Afternic; apenas 1 domínio pode ser informado por solicitação
actionA ação que você deseja definir para a confirmação do Afternic, deve ser "confirm_afternic" ou "delete_from_afternic"
Tag XML de resultado
Explicação
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Tag da resposta de Set Afternic Confirm Action, é o nó raiz do documento XML de resposta
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Definir cabeçalho da ação de confirmação do Afternic
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de definição da ação de confirmação do Afternic

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Resposta (Formato JSON)
{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Definir comando de ação de confirmação do Sedo

Suporte a multi-thread
API Sandbox não suportado

Chamar o Comando de Definir Ação de Confirmação da Sedo definirá o domínio para aprovar ou reprovar a transferência rápida na Sedo. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Definir Parâmetro de Solicitação de Ação de Confirmação do Sedo
Explicação
domainO domínio para o qual você deseja definir a ação de confirmação de transferência rápida da Sedo; apenas 1 domínio pode ser inserido por solicitação
actionA ação que você deseja definir para a confirmação do sedo, deve ser "confirm_sedo" ou "delete_from_sedo"
Tag XML de resultado
Explicação
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Tag da resposta de Set Sedo Confirm Action, é o nó raiz do documento XML de resposta
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>Definir cabeçalho de ação de confirmação do Sedo
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"

Exemplo de Definir Ação de Confirmação do Sedo

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Resposta (Formato JSON)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Comando Obter Estatísticas Whois

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando Obter Estatísticas Whois retornará as estatísticas whois. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de requisição de estatísticas do Whois
Explicação
domain_nameO nome de domínio para o qual você precisa configurar o dnssec
date_typeVocê pode escolher um campo da lista a seguir para representar seu tipo de data:
last_7_days, last_30_days, current_year, last_year
Tag XML de resultado
Explicação
<GetWhoisStatsResponse></GetWhoisStatsResponse>o nó raiz da resposta
<GetWhoisStatsHeader></GetWhoisStatsHeader>Cabeçalho de obtenção de estatísticas do Whois
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetWhoisStatsContent></GetWhoisStatsContent>conteúdo da resposta
<WhoisStats></WhoisStats>Contém vários conjuntos de dados de estatísticas whois
<WhoisStat></WhoisStat>Dados específicos de estatísticas do whois
<Date></Date>Intervalo mínimo de tempo
<Count></Count>Contagem de whois no intervalo de tempo atual

Exemplo de obtenção de estatísticas do Whois

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Solicitação de Sandbox (Formato 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
Resposta (Formato 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
      }
    ]
  }
}
 

Comando de lista de pedidos

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando de Lista de Pedidos retornará a lista de pedidos. Este comando está disponível apenas nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação da lista de pedidos
Explicação
search_byVocê pode escolher um valor da lista a seguir para representar seu tipo de pesquisa: date_range, domain, order_id
start_datea data de início da sua consulta no formato yyyy/MM/dd
end_datea data final da sua consulta no formato yyyy/MM/dd
payment_methodVocê pode escolher vários valores da lista a seguir para representar seu método de pagamento:
sem_saldo
saldo_da_conta
cartão_de_crédito
ordem_de_pagamento
Paypal
Moneybooker
transferência bancária
Alipay
payflow_credit_card2 (Não é mais usado)
wechat_pay
ecash
transferência_bancária
apple_pay
conta_corrente
venda
union_pay
conta_paypal
mercado_pago
Payoneer
mas, por favor, use vírgula para separar vários valores, por exemplo: account_balance,credit_card
Tag XML de resultado
Explicação
<OrderListResponse></OrderListResponse>o nó raiz da resposta
<OrderListHeader></OrderListHeader>Cabeçalho da lista de pedidos
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<OrderListContent></OrderListContent>Cabeçalho da lista de pedidos
<OrderList></OrderList>Contém vários conjuntos de dados de log de pedidos
<OrderItem></OrderItem>Contém dados de log de um único pedido
<OrderItemDomain></OrderItemDomain>O nome de domínio que inclui os itens neste pedido
<OrderId></OrderId>Contém o ID do pedido
<SubmittedDate></SubmittedDate>Contém a data em que o pedido foi enviado
<Cost></Cost>Inclui o custo do pedido
<Status></Status>Contém o status do pedido

Exemplo de lista de pedidos

Solicitar (formato 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
Solicitação de Sandbox (formato 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
Resposta (formato 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>
Solicitar (Formato 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
Solicitação de Sandbox (Formato 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
Resposta (Formato 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": []
      }
    ]
  }
}
 

Comando para Obter Status do Pedido

Suporte a multi-thread
Suporte a API Sandbox

Ao chamar o comando Get Order Status, você obterá o status do pedido. Este comando está disponível apenas nos formatos XML e JSON. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obter status do pedido
Explicação
order_idO id do pedido a ser consultado
Tag XML de resultado
Explicação
<GetOrderStatusResponse></GetOrderStatusResponse>o nó raiz da resposta
<GetOrderStatusHeader></GetOrderStatusHeader>Obter cabeçalho de status do pedido
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<GetOrderStatusContent></GetOrderStatusContent>conteúdo da resposta
<OrderId></OrderId>ID do pedido
<OrderStatus></OrderStatus>status do pedido( Shopping, Submitted, Waitpay, Processing, Completed, Problem, Deleted, Cancelled )
<ItemTypeName></ItemTypeName>Tipo de item
<ItemName></ItemName>Nome do item
<ItemStatus></ItemStatus>Status do Item(Concluído, Cancelado, Problema)

Exemplo de obtenção do status do pedido

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Solicitação de Sandbox (formato XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Solicitação de Sandbox (Formato JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Resposta (Formato 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"
        }
      ]
    }
  }
}
 

Comando de Processamento em Andamento

Suporte a multi-thread
Suporte a API Sandbox

Chamar o comando is_processing informará se é seguro enviar uma nova solicitação

Parâmetro de solicitação Is-Processing
Explicação
não é necessário nenhum parâmetro extra
Tag XML de resultado
Explicação
<Response></Response>Tag da resposta is_processing
<ResponseHeader></ResponseHeader>Tag do cabeçalho 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.)

Exemplo de Processamento em Andamento

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=is_processing
Resposta (formato XML)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=is_processing
Resposta (Formato JSON)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
Solicitar (formato CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing
Solicitação de Sandbox (formato CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=is_processing
Resposta (formato CSV)
ok,yes
 

Comando de Listar Cupons

Suporte a multi-thread
Suporte a API Sandbox

Chamar o Comando Listar Cupons obterá todos os cupons. Este comando está disponível apenas nos formatos XML e JSON. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para listar cupons
Explicação
coupon_typeVocê pode escolher um valor da lista a seguir para representar seu tipo de pesquisa: "registration" , "renewal" , ou "transfer"
Tag XML de resultado
Explicação
<ListCouponsResponse></ListCouponsResponse>o nó raiz da resposta
<ListCouponsHeader></ListCouponsHeader>Cabeçalho de listagem de cupons
<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>O status da solicitação
<Error></Error>Informação de erro sobre a requisição, usada apenas quando o status for "error"
<ListCouponsContent></ListCouponsContent>Conteúdo de Listar Cupons
<Coupons></Coupons>Contém vários conjuntos de dados de cupom
<Coupon></Coupon>Contém dados de um único cupom
<Code></Code>Código do cupom
<Description></Description>Descrição do cupom
<CouponType></CouponType>Tipo do cupom
<DiscountType></DiscountType>Tipo de desconto oferecido pelo cupom
<DiscountInfo></DiscountInfo>As informações de desconto do cupom
<Percentage></Percentage>A porcentagem do desconto
<AUD></AUD>Valor do desconto em Dólares Australianos
<MXN></MXN>Valor do desconto em Pesos Mexicanos
<EUR></EUR>Valor do desconto em euros
<GBP></GBP>Valor do desconto em Libras Esterlinas
<IDR></IDR>Valor do desconto em rupias indonésias
<USD></USD>Valor do desconto em Dólares dos Estados Unidos
<CAD></CAD>Valor do desconto em dólares canadenses
<INR></INR>Valor do desconto em rupias indianas
<BRL></BRL>Valor do desconto em Real brasileiro
<CNY></CNY>Valor do desconto em Yuan chinês
<Restriction></Restriction>Restrições do cupom
<PriceLevels></PriceLevels>Uma coleção de níveis de preço que suportam o uso de cupons
<UsesPerAccount></UsesPerAccount>O número de vezes que o cupom pode ser usado por conta
<UsesSystemWide></UsesSystemWide>O número de vezes que o cupom pode ser usado em todo o sistema
<UsesPerIp></UsesPerIp>O número de vezes que o cupom pode ser usado por endereço IP
<ItemsPerAccount></ItemsPerAccount>O número de itens para os quais o cupom pode ser usado por conta
<ItemsSystemWide></ItemsSystemWide>O número de itens para os quais o cupom pode ser usado em todo o sistema
<ItemsPerOrder></ItemsPerOrder>O número de itens para os quais o cupom pode ser usado por pedido
<ItemsPerDay></ItemsPerDay>O número de itens para os quais o cupom pode ser usado por dia
<IdnRestriction></IdnRestriction>Restrições de IDN para o cupom
<DomainDurationMin></DomainDurationMin>Duração mínima do domínio
<DomainDurationMax></DomainDurationMax>Duração máxima do domínio
<Tlds></Tlds>Uma coleção de domínios de nível superior que aceitam o uso de cupons
<Tld></Tld>Um único domínio de nível superior que suporta o uso de cupons
<Currencies></Currencies>Uma coleção de tipos de moeda que suportam o uso de cupons
<Currency></Currency>Um único tipo de moeda que suporta o uso de cupons
<StartDate></StartDate>A data de início da validade do cupom
<EndDate></EndDate>A data de término da validade do cupom

Exemplo de lista de cupons

Solicitar (formato XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_coupons&coupon_type=renewal
Solicitação de Sandbox (formato XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
Resposta (formato 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>
Solicitar (Formato JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=list_coupons&coupon_type=renewal
Solicitação de Sandbox (Formato JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
Resposta (Formato 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"
      }
    ]
  }
}