Domínios

Lista de Comandos da API de Domínio

Nossa API é sua ferramenta avançada de gestão e aquisição de domínios construída para eficiência. Com mais de 50 comandos para configurar, gerenciar, registrar e licitar 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ínio está disponível para todas as contas, então comece hoje mesmo!

Começando com a nossa API Avançada de Domínios

As solicitações à nossa API de Domínio Avançado são enviadas para o seguinte URL:

https://api.dynadot.com/api3.xml (Não é permitido traduzir asteriscos, marcas, símbolos ou etiquetas HTML. Apenas as palavras devem ser traduzidas.)

As solicitações devem ser enviadas por https (socket seguro) para segurança. Apenas uma solicitação pode ser processada de cada vez, então, por favor, aguarde o término da sua solicitação atual antes de enviar outra solicitação. A solicitação deve ter os dois seguintes parâmetros: uma 'Chave' e um 'Comando'. Os comandos podem ser clicados para ver os parâmetros associados a eles.


 
Parâmetro de solicitação
Explicação
KeySua chave de acesso à API está disponível em seu painel de controle da conta Dynadot no menu lateral 'Ferramentas' -> 'API'.
Commandsearch, register, delete, renew, push, lock, transfer, bulk_register

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

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, cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns

set_reseller_hold_status, get_reseller_hold_status, get_listings, get_listing_item, buy_it_now

account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, set_default_email_forward, set_clear_default_setting, set_default_renew_option

create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_dns2, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list

add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, get_auction_bids, place_auction_bid, get_closed_auctions

is_processing

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_order_status

get_domain_push_request, set_domain_push_request, set_afternic_confirm_actionset_sedo_confirm_action, set_domain_dnssec, get_whois_stats, order_list,

Nossa API de Domínio Avançada retornará resultados em formato XML. A resposta que você receber deve conter 2 ou 3 dos seguintes campos:

Tag do resultado em XML
Explicação
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
 

Comando de Pesquisa

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

Parâmetro de Solicitação de Pesquisa
Explicação
domain0 - domain99O nome de domínio que você está procurando, conta comum pode especificar 1 domínio por comando, contas de Massa e super massa podem especificar até 100 domínios
language0 - language99 (opcional)O marcador de idioma do domínio respectivo, apenas para IDNs
show_price (opcional)Se quiser mostrar o preço na moeda da sua conta, defina como "1".
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
Tag do resultado em XML
Explicação
<Results></Results>O nó raiz da resposta XML do comando de pesquisa
<SearchResponse></SearchResponse>Tag da resposta de pesquisa
<SearchHeader></SearchHeader>Cabeçalho da tag de pesquisa
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "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 domínio

Exemplo de Pesquisa

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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

Chamar o comando de registro irá criar e processar um pedido de registo. Você deve ter saldo suficiente na conta para pagar pela compra. Ao chamar o comando de registo, os seguintes parâmetros devem ser incluídos:

Parâmetro de 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 (opcional)O marcador de idioma do domínio solicitado. Necessário apenas quando o domínio é um IDN
durationPor quanto tempo registrar o domínio.
registrant_contact (opcional)O contato do registrante que você deseja usar no domínio
admin_contact (opcional)O contato de administração que deseja usar no domínio
technical_contact (opcional)O contato técnico que deseja usar no domínio
billing_contact (opcional)O contato de cobrança que você deseja usar no domínio
option0 (se necessário)
O nome do registrante de .AT, .BE,
option1 (se necessário)A organização registrante .AT, .BE, (opcional)
Para .AT, você pode especificar option0, option1, ou ambos
premium (opcional)Se você quiser registrar um domínio premium, defina como igual a "1" (opcional)
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
coupon (opcional)O código de cupom que você quer aplicar a este comando
Tag do resultado em XML
Explicação
<RegisterResponse></RegisterResponse>Tag da resposta de registro
<RegisterHeader></RegisterHeader>Cabeçalho da tag de registro
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<RegisterContent></RegisterContent>A tag do conteúdo de registro
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"
<Registration></Registration>Data de registro em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"

Exemplo de Registro

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=register&domain=domain1.net&duration=3&currency=USD

Resposta (formato XML)
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=register&domain=domain1.net&duration=3&currency=USD

Resposta (formato JSON)
{
   "RegisterResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.net",
      "Expiration":"1458379145266"
   }
}
 

Comando de Exclusão

Usar o comando delete excluirá um domínio que ainda está no período de tolerância. O saldo da sua conta será creditado de volta com a taxa de registro menos quaisquer taxas de exclusão. Os domínios que foram renovados ou que foram movidos para outra conta não podem ser excluídos por meio da API. Ao usar o comando delete, os seguintes parâmetros devem ser incluídos:

Parâmetro da 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 do resultado em XML
Explicação
<DeleteResponse></DeleteResponse>Tag da resposta de exclusão
<DeleteHeader></DeleteHeader>Cabeçalho da tag de exclusão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=delete&domain=domain1.com

Resposta (formato XML)
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=delete&domain=domain1.com

Resposta (formato JSON)
{
   "DeleteResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
   }
}
 

Comando de Renovação

Fazer o comando de renovação irá criar e processar um pedido de renovação. Você deve ter saldo o suficiente em conta para pagar por um pedido. Se estiver pedindo o comando de renovação, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Renovação
Explicação
domainO nome de domínio que você deseja renovar, somente 1 domínio pode ser renovado por solicitação
durationPor quantos anos renovar o domínio
year (opcional)O ano atual no qual o domínio expira
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
price_check (opcional)Você pode adicionar este parâmetro para o comando para verificar os detalhes de preço para renovar este domínio. ATENÇÃO: Adicionar este parâmetro ao comando, nosso api não irá renovar o domínio, mas irá apenas apresentar as informações de preço.
coupon (opcional)O código de cupom que você quer aplicar a este comando
no_renew_if_late_renew_fee_needed (opcional)Você pode adicionar esse parâmetro ao comando para evitar a renovação se o domínio precisar pagar taxa de renovação tardia. Se o domínio precisar pagar taxa de renovação tardia para renovação e 'no_renew_if_late_renew_fee_needed = 1' foi passado no comando, o domínio não será renovado.
Tag do resultado em XML
Explicação
<RenewResponse></RenewResponse>Marcador da resposta de renovação. É o nó raiz do documento de resposta XML
<RenewHeader></RenewHeader>Cabeçalho de renovação
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<PriceInfo></PriceInfo>Informação da etiqueta de preço, só é usada para quando o status do domínio é "price_check_success";
<RenewContent></RenewContent>Marcador de renovação de conteúdo, usado apenas quando o status é "success"
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"

Exemplo de Renovação

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Resposta (formato JSON)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domian1.com",
      "Expiration":"73984579834"
   }
}
 

Comando de empurrão

Fazer o comando de push irá criar um processo de pedido de push. Você precisa desbloquear seu domínio e conta para pedir. A conta remetente precisa rejeitar/aceitar o domínio para completar o pedido. Ao fazer o comando de push, os seguintes parâmetros devem ser inclusos:

Parâmetros de Requerimento de Push
Explicação
domainO nome de domínio que você quer enviar. Nós também suportamos envios em massa, você pode usar ";" para separar domínios. Exemplo: domínio1.com;domínio2.com
receiver_push_usernameInserir nome de usuário da conta destinatária
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
unlock_domain_for_push(optional)Defina este parâmetro igual a "1" se o domínio estiver bloqueado, nós o desbloquearemos automaticamente, para que você não tenha que debloquear o domínio manualmente
Tag do resultado em XML
Explicação
<PushResponse></PushResponse>Tag de resposta de push, é o nó raiz necessário para responder o documento XML
<PushHeader></PushHeader>Cabeçálio de Push
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exem´plo de Push

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Resposta (formato JSON)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

Comando de Transferência

Pedir um comando de transferência irá criar e processar um pedido de transferência. Alguns tlds podem requerer que o registrante perdedor confirme para completar o pedido. Os seguintes parâmetros devem ser inclusos se estiver pedindo um comando de transferência.

Parâmetro do Pedido de Transferência
Explicação
domainO nome de domínio que você quer transferir para sua conta Dynadot, apenas 1 domínios podem ser transferidos por pedido.
authO código de autorização para o pedido de transferência.
currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta
registrant_contact (opcional)O contato de registrante que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)
admin_contact (opcional)O contato admin que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)
technical_contact (opcional)O contato técnico que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)
billing_contact (opcional)O contato de cobrança que você quer usar quando a transferência estiver completa. N(Nem todos os tlds suportam esta característica)
coupon (opcional)O código de cupom que você quer aplicar a este comando
Tag do resultado em XML
Explicação
<TransferResponse></TransferResponse>Resposta de tag de transferência, é o root node do documento de resposta XML
<TransferHeader></TransferHeader>Cabeçalho da transferência
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Transferência

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Resposta (formato XML)
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </TransferHeader>
</TransferResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Resposta (formato JSON)
{
   "TransferResponse":{
      "ResponseCode":"0",
      "Status":"order created",
      "DomainName":"domian1.com"
   }
}
 

Comando de registro em massa

A chamada do comando de registro em massa criará e processará ordens de registro. Você deve ter saldo suficiente na conta para pagar pelas ordens. Se chamar o comando de registro em massa, 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, um máximo de 100 domínios pode ser registrado por solicitação
premium (opcional)Se você quiser registrar um domínio premium, defina como igual a "1" (opcional)
currency (opcional)Você pode decidir o tipo de moeda e os parâmetros suportados são "USD", "CNY", "GBP", "EUR", "INR", "CAD" e assim por diante. Se você perder esse parâmetro, usaremos a moeda padrão da conta
coupon (opcional)O código de cupom que você quer aplicar a este comando
Tag do resultado em XML
Explicação
<BulkRegisterResponse></BulkRegisterResponse>Tag de resposta de registro em massa
<BulkRegisterHeader></BulkRegisterHeader>Tag de cabeçalho de registro em massa
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<BulkRegisterContent></BulkRegisterContent>A etiqueta do registro em massa de conteúdo
<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"
<Result></Result>O resultado da ação de registro
<Message></Message>Mensagem de erro de ação de registro, só utilizada quando o resultado é "error"

Exemplo de registro em massa

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de Domínios

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

Parâmetro de Solicitação de Informações de Domínios
Explicação
domainApenas 1 domínio permitido por solicitação
Tag do resultado em XML
Explicação
<DomainInfoResponse></DomainInfoResponse>Nó raiz do documento de resposta XML
<DomainInfoResponseHeader></DomainInfoResponseHeader>Cabeçalho de resposta
<ResponseCode></ResponseCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<DomainInfoContent></DomainInfoContent>Conteúdo de 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 meia-noite UTC de 1 de janeiro de 1970)
<Registration></Registration>Data de registro de Domínio é em tempo Unix (milissegundos após a meia-noite UTC de 1, 1970 de Janeiro)
<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 o seu domínio
<Whois></Whois>Informações do Whois
<Registrant></Registrant>Informações do registrante
<ContactId></ContactId>ID do contato
<Admin></Admin>Informações administrativas
<Technical></Technical>Informações técnicas
<Billing></Billing>Informações de cobrança
<Locked></Locked>Bloqueado ou não
<Disabled></Disabled>Status habilitado
<UdrpLocked></UdrpLocked>UDRP bloqueado ou não
<UdrpLocked></UdrpLocked>UDRP bloqueado ou não
<RegistrantUnverified></RegistrantUnverified>Registrante não verificado
<Hold></Hold>Retido
<Privacy></Privacy>Status de privacidade
<isForSale></isForSale>Status da venda
<RenewOption></RenewOption>Opção de renovação
<Note></Note>Notas
<Folder></Folder>Informações da pasta
<FolderId></FolderId>ID da Pasta
<FolderName></FolderName>Nome da pasta

Exemplo de Informações de Domínio

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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)"
      }
    }
  }
}
 

Comando de Definição de Whois

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

Parâmetro de Solicitação de Definição de 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 eles estejam separados por vírgulas
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactAs informações técnicas do domínio
billing_contactAs informações de cobrança do domínio
Tag do resultado em XML
Explicação
<SetWhoisResponse></SetWhoisResponse>Nó raiz do documento de resposta XML
<SetWhoisHeader></SetWhoisHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Whois

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de Definição de Servidores de Nomes

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

Parâmetro de Solicitação de Definição de Servidores de Nomes
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
ns0 - ns12Os servidores de nome definidos para uso do seu domínio. Você pode especificar até 13 servidores de nome, mas eles já devem estar na sua conta
Tag do resultado em XML
Explicação
<SetNsResponse></SetNsResponse>Marcador da resposta de definição de servidor de nomes. É o nó raiz do documento de resposta XML
<SetNsHeader></SetNsHeader>Cabeçalho de resposta de definição de servidor de nomes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Servidor de Nomes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Resposta (formato XML)
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de Definição de Estacionamento

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

Parâmetro de 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 eles estejam separados por vírgulas
with_ads (opcional)Se não quiser anúncios de terceiros, você pode usar este parâmetro com "no"
Tag do resultado em XML
Explicação
<SetParkingResponse></SetParkingResponse>Marcador da resposta de definição de estacionamento. É o nó raiz do documento de resposta XML
<SetParkingHeader></SetParkingHeader>Cabeçalho de definição de pasta de estacionamento
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Estacionamento

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_parking&domain=domain1.com&with_ads=no

Resposta (formato XML)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_parking&domain=domain1.com&with_ads=no

Resposta (formato JSON)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Redirecionamento

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

Parâmetro de Solicitação de Definição de Redirecionamento
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"
Tag do resultado em XML
Explicação
<SetForwardingResponse></SetForwardingResponse>Nó raiz do documento de resposta XML
<SetForwardingHeader></SetForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com

Resposta (formato XML)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com

Resposta (formato JSON)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Secretividade

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

Parâmetro de Solicitação de Definição de Secretividade
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
stealth_title (opcional)O título da página
Tag do resultado em XML
Explicação
<SetStealthResponse></SetStealthResponse>Nó raiz do documento de resposta XML
<SetStealthHeader></SetStealthHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Secretividade

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Resposta (formato XML)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Resposta (formato JSON)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Hospedagem

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

Parâmetro de Solicitação de Definição de 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 eles estejam separados por vírgulas
hosting_typeTipo de hospedagem que você deseja. Você pode selecionar "advanced" e "basic"
mobile_view_onSomente quando hosting_type é "advanced", você pode usar esse parâmetro como "yes"
Tag do resultado em XML
Explicação
<SetHostingResponse></SetHostingResponse>Nó raiz do documento de resposta XML
<SetHostingHeader></SetHostingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Hospedagem

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes

Resposta (formato JSON)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Definir comando DNS2

Ao fazer um comando DNS2, os seguintes parâmetros devem ser inclusos:

Atenção: Usar o comando DNS2 irá sobrescrever a configuração DNS atual.

Parâmetro de definição de solicitação de 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 eles 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 envio(301 como "1", 302 como "2"), título de envio oculto ou alias de e-mail quando o tipo_de_registro_p´rincial é "forward", "mx", "oculto", "e-mail".
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99O tipo de subdomínio deve ser "a", "aaaa", "cname", "encaminhamento", "txt", "srv", "mx", "privado", "e-mail"
sub_record0 - sub_record99Endereço IP do subdomínio ou host de destino
sub_recordx0 - sub_recordx99Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias de e-mail quando o registro_principal é "encaminhado" "mx", "privado", "e-mail"
ttl (opcional)Tempo de existência
add_dns_to_current_setting (opcional)Se desejar acrescentar as novas configurações de DNS às configurações de DNS existentes. Defina-o como "1" (opcional)
Tag do resultado em XML
Explicação
<SetDnsResponse></SetDnsResponse>Nó raiz do documento de resposta XML
<SetDnsHeader></SetDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Definir exemplo de DNS2

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 Redirecionamento de E-mails

Ao chamar o comando de definição de redirecionamento de e-mails, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Redirecionamento de E-mails
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
forward_typeTipo de encaminhamento: pode ser "donot": para não encaminhar e-mail, "mx": para entregar e-mail em outra hospedagem de e-mails (registro MX) ou "forward": entregar e-mail em outra hospedagem de e-mails
username0 - username9Nome de usuário, usado somente quando "forward_type" for "forward".
exist_email0 - exist_email9Endereço de e-mail atual, usado somente quando "forward_type" for "forward".
mx_host0 - mx_host2Hospedagem de e-mails, usado somente quando "forward_type" for "mx".
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado somente quando "forward_type" for "mx".
Tag do resultado em XML
Explicação
<SetEmailForwardingResponse></SetEmailForwardingResponse>Nó raiz do documento de resposta XML
<SetEmailForwardingHeader></SetEmailForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento de E-mails

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]

Resposta (formato XML)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]

Resposta (formato JSON)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Limpeza de Configurações de Domínio

Ao chamar o comando de configuração da limpeza de domínios, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Limpeza de Configurações 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 eles estejam separados por vírgulas
serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"
Tag do resultado em XML
Explicação
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nó raiz do documento de resposta XML
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

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

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_domain_setting&domain=domain1.com&service=nameservers

Resposta (formato XML)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_clear_domain_setting&domain=domain1.com&service=nameservers

Resposta (formato JSON)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Pasta

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

Parâmetro de 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 deseja mover o seu domínio. Use "Default" como o nome da pasta, se você 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 pastas diferentes.
folder_id (opcional)A ID da pasta para a qual deseja mover o seu domínio
Tag do resultado em XML
Explicação
<SetFolderResponse></SetFolderResponse>Marcador da resposta de definição de pasta. É o nó raiz do documento de resposta XML
<SetFolderHeader></SetFolderHeader>Cabeçalho de definição de pasta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder&domain=domian1.com&folder=folder1

Resposta (formato XML)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder&domain=domian1.com&folder=folder1

Resposta (formato JSON)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Opções de Renovação

Ao chamar o comando de definição das opções de renovação, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição das Opções 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 eles estejam separados por vírgulas
renew_optionPode ser "donot", "auto", "reset"
Tag do resultado em XML
Explicação
<SetRenewOptionResponse></SetRenewOptionResponse>Nó raiz do documento de resposta XML
<SetRenewOptionHeader></SetRenewOptionHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição das Opções de Renovação

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto

Resposta (formato XML)
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto

Resposta (formato JSON)
{
   "SetRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Nota

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

Parâmetro de Solicitação de Definição de 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 do resultado em XML
Explicação
<SetNoteResponse></SetNoteResponse>Nó raiz do documento de resposta XML
<SetNoteHeader></SetNoteHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Notas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_note&domain=domain1.com&note=Do not modify any information

Resposta (formato JSON)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Configuração de Id do Cliente (APENAS PARA REVENDEDORES)

Se o comando de definir ID do cliente for chamado, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de ID do cliente
Explicação
domainO domínio que deseja definir , vários domínios são separados por vírgulas ( Max :100 )
customer_idO ID do cliente que você deseja definir para o domínio não pode ser nulo
Tag do resultado em XML
Explicação
<SetCustomerIdResponse></SetCustomerIdResponse>Nó raiz do documento de resposta XML
<SetCustomerIdHeader></SetCustomerIdHeader>Cabeçalho de resposta
<SetCustomerIdContent></SetCustomerIdContent>Conteúdo de resposta
<SetCustomerIdSuccess></SetCustomerIdSuccess>Conteúdo de resposta de sucesso ao definir o ID do cliente
<SetCustomerIdFailed></SetCustomerIdFailed>Falha na configuração do ID do cliente no conteúdo da resposta
<ResponseCode></ResponseCode>Se a operação for bem sucedida, "0" para sucesso, "-1" para falha, "1" para problema
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Identificação do Cliente

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Resposta (formato XML)
<SetCustomerIdResponse>
    <SetCustomerIdHeader>
        <ResponseCode>0</ResponseCode>
        <Status>success</Status>
    </SetCustomerIdHeader>
    <SetCustomerIdContent>
        <SetCustomerIdSuccess>
            <content>
                <Domain>domain1.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
            <content>
                <Domain>domain2.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
        </SetCustomerIdSuccess>
    </SetCustomerIdContent>
</SetCustomerIdResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

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

Comando de Definição de Privacidade

Ao chamar o comando de definição de privacidade, 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 eles estejam separados por vírgulas
optionO status de privacidade do domínio que deseja definir. Pode ser "full", "partial", ou "off"
Tag do resultado em XML
Explicação
<SetPrivacyResponse></SetPrivacyResponse>Nó raiz do documento de resposta XML
<SetPrivacyHeader></SetPrivacyHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Privacidade

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_privacy&domain=domain1.com&option=off

Resposta (formato XML)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_privacy&domain=domain1.com&option=off

Resposta (formato JSON)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Preços de TLD

Essa funcionalidade está disponível apenas no formato XML e JSON:

Pedido de Parâmetros de Preços Tld
Explicação
currency (opcional)A moeda de resultado de retorno, deve ser "usd", "eur", ou "cny", a moeda padrão é a MOeda Padrão Api das definições da conta.
Tag do resultado em XML
Explicação
<TldPriceResponse></TldPriceResponse>Nó raiz do documento de resposta XML
<TldPriceResponseHeader></TldPriceResponseHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<TldPriceContent></TldPriceContent>Conteúdo de resposta
<TldContent></TldContent>Informações de Tld
<Tld></Tld>Domínios de Topo
<Usage></Usage>Uso de tld
<Price></Price>Informações de preço deste TLD. Contém subetiquetas: : Unidade de preço : Preço de registro : Preço de renovação : Preço de transferência.
<Privacy></Privacy>Se este tld suporta privacidade
<GracePeriod></GracePeriod>Informações do período de carência deste tld. Contém subetiquetas: : Unidade de informações do período de carência : Período de carência para renovação : Período de carência para exclusão
<IDN></IDN>Se este tld suporta Nomes de Domínios Internacionalizados
<Restrictions></Restrictions>Nome do domínio

Exmplo de Preços de TLD

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=0&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>Usage</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>99.00</Register>
        <Renew>60.00</Renew>
        <Transfer>92.00</Transfer>
      </Price>
      <Privacy>Yes</Privacy>
      <GracePeriod>
        <Unit>(Grace Period/days)</Unit>
        <Renew>40</Renew>
        <Delete>5</Delete>
      </GracePeriod>
      <IDN>Yes</IDN>
      <Restrictions>--</Restrictions>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=0&command=tld_price&currency=USD

Resposta (formato JSON)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": ".com",
        "Usage": "Usage",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "99.00",
          "Renew": "60.00",
          "Transfer": "92.00"
        },
        "Privacy": "Yes",
        "GracePeriod": {
          "Unit": "(Grace Period/days)",
          "Renew": "40",
          "Delete": "5"
        },
        "IDN": "Yes",
        "Restrictions": "--"
      }
    ]
  }
}
 

Comando de Listagem dos Domínios

Essa funcionalidade está disponível apenas no formato XML e JSON:

Parâmetro de Solicitação de Listagem de Domínios
Explicação
customer_id (opcional)Filtrar dados por ID de cliente ( apenas revendedores podem usar esse parâmetro )
Tag do resultado em XML
Explicação
<ListDomainInfoResponse></ListDomainInfoResponse>Nó raiz do documento de resposta XML
<ListDomainInfoHeader></ListDomainInfoHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<ListDomainInfoContent></ListDomainInfoContent>Conteúdo de resposta
<DomainInfoList></DomainInfoList>Lista de informações dos domínios
<DomainInfo></DomainInfo>Informações do domínio
<Domain></Domain>Domínio
<Name></Name>Nome do domínio
<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Registration></Registration>Data de registro de Domínio é em tempo Unix (milissegundos após a meia-noite UTC de 1, 1970 de Janeiro)
<NameServerSettings></NameServerSettings>Configurações de servidores de nomes
<Type></Type>Tipo de configuração de servidor de nomes
<WithAds></WithAds>Com anúncios ou não
<Whois></Whois>Informações do Whois
<Registrant></Registrant>Informações do registrante
<ContactId></ContactId>ID do contato
<Admin></Admin>Informações administrativas
<Technical></Technical>Informações técnicas
<Billing></Billing>Informações de cobrança
<Locked></Locked>Bloqueado ou não
<Disabled></Disabled>Status habilitado
<Hold></Hold>Retido
<Privacy></Privacy>Status de privacidade
<isForSale></isForSale>Status da venda
<RenewOption></RenewOption>Opção de renovação
<Note></Note>Notas
<Folder></Folder>Informações da pasta
<FolderId></FolderId>ID da Pasta
<FolderName></FolderName>Nome da pasta

Exemplo de Listagem de Domínios

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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)"
        }
      },
      {
        "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)"
        }
      }
    ]
  }
}
 

Comando de Criação de Contatos

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

Parâmetro de Solicitação de Criação de Contato
Explicação
organization (opcional)Informações da organização
nameNome
emailE-mail
phonenumNúmero de telefone
phoneccCódigo de telefone do país
faxnum (opcional)Número de fax
faxcc (opcional)Código de fax do país
address1Endereço 1
address2 (opcional)Endereço 2
cityCidade
state (opcional)Estado
zipCEP
countryPaís
Tag do resultado em XML
Explicação
<CreateContactResponse></CreateContactResponse>Nó raiz do documento de resposta XML
<CreateContactHeader></CreateContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<CreateContactContent></CreateContactContent>Novo ID de contato, só usado quando o status é "success".

Exemplo de Criação de Contatos

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de Edição de Contato

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

Parâmetro de Solicitação de Edição de Contato
Explicação
contact_idID do contato que deseja editar
organization (opcional)Informações da organização
nameNome
emailE-mail
phonenumNúmero de telefone
phoneccCódigo de telefone do país
faxnum (opcional)Número de fax
faxcc (opcional)Código de fax do país
address1Endereço 1
address2 (opcional)Endereço 2
cityCidade
stateEstado
zipCEP
countryPaís
Tag do resultado em XML
Explicação
<EditContactResponse></EditContactResponse>Nó raiz do documento de resposta XML
<EditContactHeader></EditContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<EditContactContent></EditContactContent>Conteúdo de resposta
<ContactId></ContactId>ID do contato
Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato CSV)

https://api.dynadot.com/api3.html?key=mykey&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,
,
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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"
    }
  }
}
 

Definir Comando de Configuração de Contato da UE

Se ao chamar o comando de configuração de contato do UE, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de configuração do contato da UE
Explicação
contact_idID do contato que 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 do resultado em XML
Explicação
<SetContactEUSettingResponse></SetContactEUSettingResponse>Nó raiz do documento de resposta XML
<SetContactEUSettingHeader></SetContactEUSettingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Conteúdo de resposta
<ContactId></ContactId>ID do contato

Definir exemplo de configuração de contato da UE

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 configuração de LV de contato definido

Se a chamada do comando de configuração do nível de contato definido, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de configuração de contato LV
Explicação
contact_idID do contato que deseja editar
registration_number- Para indivíduos, por favor, digite o número de identificação letão.
- Para empresas e outras entidades legais, por favor, digite o número de registro emitido pelo Registro de Empresas da Letônia.
vat_number (opcional)Número de IVA para entidades legais estrangeiras registradas em países da União Europeia (isso inclui também empresas letãs)
Tag do resultado em XML
Explicação
<SetContactLvSettingResponse></SetContactLvSettingResponse>Nó raiz do documento de resposta XML
<SetContactLvSettingHeader></SetContactLvSettingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Conteúdo de resposta
<ContactId></ContactId>ID do contato

Exemplo de configuração de LV de contato definido

Pedido (formato CSV)

https://api.dynadot.com/api3.csv?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Resposta (formato CSV)
ok,success,0
Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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"
    }
  }
}
 

Comando de Exclusão de Contatos

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

Parâmetro de Solicitação de Exclusão de Contatos
Explicação
contact_idAs IDs dos contatos que você deseja excluir, certifique-se de que estejam separadas por vírgulas
Tag do resultado em XML
Explicação
<DeleteContactResponse></DeleteContactResponse>Nó raiz do documento de resposta XML
<DeleteContactHeader></DeleteContactHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão de Contatos

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_contact&contact_id=0

Resposta (formato XML)
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>-1</SuccessCode>
    <Status>error</Status>
    <Error>cannot delete these contacts (Jack Slater). Because they are in use.</Error>
  </DeleteContactHeader>
</DeleteContactResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=delete_contact&contact_id=0

Resposta (formato JSON)
{
   "DeleteContactResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Listagem dos Contatos

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

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

Exemplo de Lista de Contatos

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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 Slater</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 Free Way</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=contact_list

Resposta (formato JSON)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack Slater",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 Free Way",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}
 

Parâmetro de Obtenção de Contato

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

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

Exemplo de Obtenção de Contatos

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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 protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=get_contact&contact_id=10000

Resposta (formato JSON)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "[email protected]",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

Receber Comando de Nome de Servidor

Se chamar o comando de obter o servidor de nomes, os seguintes parâmetros devem ser incluídos:

Receber Parâmetro de Pedido de Nome de Servidor
Explicação
domainO domínio cujas informações de servidor de nome se deseja obter, apenas as informações de servidor de nomes de 1 domínio podem ser recebidas por solicitação.
Tag do resultado em XML
Explicação
<GetNsResponse></GetNsResponse>Nó raiz do documento de resposta XML
<GetNsHeader></GetNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<NsContent></NsContent>Conteúdo de resposta
<Host></Host>Nome de Hospedagem do servidor
<NsName></NsName>Nome do servidor

Receber Exemplos de Nomes de Servidores

Pedido (formato XML)

https://api.dynadot.com/api3.html?key=mykey&command=get_ns&domain=mydomain.com

Resposta (formato XML)
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=get_ns&domain=mydomain.com

Resposta (formato JSON)
{
   "GetNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "NsContent":{
         "Host":"ns1.mydomain.com",
         "Host":"ns2.mydomain.com"
      }
   }
}
 

Comando de Adição de Servidor de Nomes

Ao chamar o comando de adicionar servidor de nomes, os seguintes parâmetros devem ser incluídos:

Adicionar Parâmetro de Solicitação de Servidor de Nomes
Explicação
hostO nome da hospedagem do servidor de nomes que você deseja adicionar
Tag do resultado em XML
Explicação
<AddNsResponse></AddNsResponse>Nó raiz do documento de resposta XML
<AddNsHeader></AddNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<AddNsContent></AddNsContent>Conteúdo de resposta
<Server></Server>O servidor que você definiu
<Host></Host>Nome de hospedagem do novo servidor
<ServerId></ServerId>ID do novo servidor

Exemplo de Adição de Servidor de Nomes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=add_ns&host=ns1.mydomain.com

Resposta (formato XML)
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=add_ns&host=ns1.mydomain.com

Resposta (formato JSON)
{
   "AddNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "AddNsContent":{
         "Server":{
            "Host":"ns1.mydomain.com",
            "ServerId":"0"
         }
      }
   }
}
 

Comando de Registro de Servidor de Nomes

Ao chamar 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 do resultado em XML
Explicação
<RegisterNsResponse></RegisterNsResponse>Nó raiz do documento de resposta XML
<RegisterNsHeader></RegisterNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<RegisterNsContent></RegisterNsContent>Conteúdo de resposta
<Server></Server>Tag do servidor
<Host></Host>Nome da hospedagem
<ServerId></ServerId>ID do servidor

Exemplo de Registro de Servidor de Nomes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 Definição de IP de Servidor de Nomes

Ao chamar o comando de configuração de IP de um servidor de nomes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de IP de Servidor de Nomes
Explicação
server_idA ID do servidor de nomes que você deseja definir
ip0 - ip9O endereço IP que você deseja definir para o servidor de nomes. 9 IPs podem ser definidos por solicitação e devem ser separados por vírgulas
Tag do resultado em XML
Explicação
<SetNsIpResponse></SetNsIpResponse>Nó raiz do documento de resposta XML
<SetNsIpHeader></SetNsIpHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de IP de Servidores de Nomes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Resposta (formato JSON)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Exclusão de Servidor de Nomes

Se chamar o comando de exclusão de servidores 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_idA ID dos servidores de nomes que você deseja excluir, certifique-se de separá-las com vírgulas
Tag do resultado em XML
Explicação
<DeleteNsResponse></DeleteNsResponse>Nó raiz do documento de resposta XML
<DeleteNsHeader></DeleteNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão de Servidor de Nomes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns&server_id=0

Resposta (formato XML)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=delete_ns&server_id=0

Resposta (formato JSON)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Apagamento de Nome de Servidor pelo Domínio

Se o comando de exclusão do servidor de nomes por domínio for chamado, os seguintes parâmetros devem ser incluídos:

Parâmetro de Apagamento de Nome de Domínio Por Pedido de Domínio
Explicação
server_domainNome do nome servidor name. ex.: ns1.testnameserver.com
Tag do resultado em XML
Explicação
<DeleteNsResponse></DeleteNsResponse>Nó raiz do documento de resposta XML
<DeleteNsHeader></DeleteNsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Apagamento de Nome de Domínio

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Resposta (formato XML)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Resposta (formato JSON)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Listagem de Servidores

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

Parâmetro de Solicitação de Listagem de Servidores
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<ServerListResponse></ServerListResponse>Nó raiz do documento de resposta XML
<ServerListHeader></ServerListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<ServerListContent></ServerListContent>Conteúdo de resposta
<NameServerList></NameServerList>Lista de servidores de nome
<List></List>
<Server></Server>
<ServerId></ServerId>ID do servidor
<ServerName></ServerName>Name do servidor
<ServerIp></ServerIp>IP do servidor

Exemplo de Listagem de Servidores

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 para obter as configurações do servidor DNS de domínio

Se estiver chamando o comando de configurações de servidores de nomes de domínio, os seguintes parâmetros devem ser incluídos:

Obter parâmetro de solicitação de configurações de servidor de nomes de domínio
Explicação
domainO domínio cuja configuração do servidor de nomes você deseja obter pode ser puxado por solicitação somente para a configuração do servidor de nomes do domínio 1.
Tag do resultado em XML
Explicação
<GetDnsResponse></GetDnsResponse>Nó raiz do documento de resposta XML
<GetDnsHeader></GetDnsHeader>Cabeçalho de resposta
<ResponseCode></ResponseCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetDnsContent></GetDnsContent>Conteúdo de resposta
<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio
<Type></Type>Tipo de servidor de nomes do domínio

Obter Exemplo de Configurações de Servidores de Nomes de Domínio

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=get_dns&domain=mydomain.com

Resposta (formato JSON)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

Comando Para o Código de Transferência Auth

Você precisa desbloquear seu domino e conta antes de pedir o código de autenticação.

Receba um Parâmetro para o Pedido de Auth Code
Explicação
domainO nome de domínio para o qual você quer um código de autenticação de transferência, apenas domínios 1 podem ser inseridos por pedido.
new_code (optional)Gerar novo auth code de transferência.
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Se você quer desbloquear domínios para transferência, defina igual a "1". Se o pedido for processado com sucesso, o domínio será desbloqueado.
Tag do resultado em XML
Explicação
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>O root node do documento XML de respostaXML.
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<AuthCode></AuthCode>O Auth Code é usado para começar uma transferência de domínio.

Exemplo de Recebimento de Auth Code de Transferência

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Resposta (formato XML)
<GetTransferAuthCodeResponse>
   <GetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
      <AuthCode>testauthcode</AuthCode>
   </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de Status de Transferência

Ao chamar o comando de obtenção de status de transferência, os seguintes parâmetros devem ser incluídos:

Obter parâmetro de solicitação de status de transferência
Explicação
domainO nome de domínio que você deseja obter o status de transferência, somente 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ência de entrada ou transferência de saída)
Tag do resultado em XML
Explicação
<GetTransferStatusResponse></GetTransferStatusResponse>O root node do documento XML de respostaXML.
<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetTransferStatusContent></GetTransferStatusContent>Conteúdo de resposta
<TransferList></TransferList>Lista de transferência
<Transfer></Transfer>Transferir informações
<OrderId></OrderId>O ID do pedido
<TransferStatus></TransferStatus>O status de transferência do domínio. Se você obteve 'nenhum' ou 'aprovado', pode cancelar a transferência. Se você obteve 'aguardando', significa que a transferência já começou. Se você obteve 'código de autorização necessário', significa que o código de autorização está incorreto, você pode usar outra API SET_TRANSFER_AUTH para reenviar o código de autorização. Há também outros estados, enviaremos um e-mail ou precisará ser verificado por nossos engenheiros.

Obter Exemplo de Status de Transferência

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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"
      }
    ]
  }
}
 

Definir código de autorização de transferência para o comando de ordem de transferência

O comando que permite atualizar o código de autenticação para processar pedidos de transferência. Se estiver a chamar o comando de definição de código de autenticação de transferência, os seguintes parâmetros devem ser incluídos:

Definir parâmetro de solicitação de 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 só pode ser inserido um domínio 1 por solicitação
auth_codeO código de autenticação que você deseja reenviar
order_idO ID do pedido de transferência pode ser obtido de outra API get_transfer_status.
Tag do resultado em XML
Explicação
<GetTransferStatusResponse></GetTransferStatusResponse>O root node do documento XML de respostaXML.
<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

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

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Resposta (formato XML)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Resposta (formato JSON)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Cancelar Transferência Para Comando de Pedido

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

Parâmetro de Cancelamento de Solicitação de Transferência
Explicação
domainO nome de domínio que você deseja cancelar a transferência, somente um domínio 1 pode ser inserido por solicitação
order_idO ID do pedido de transferência pode ser obtido de outra API get_transfer_status.
Tag do resultado em XML
Explicação
<CancelTransferResponse></CancelTransferResponse>O root node do documento XML de respostaXML.
<CancelTransferHeader></CancelTransferHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de cancelamento de transferência

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=cancel_transfer&domain=domain4.com

Resposta (formato XML)
<CancelTransferResponse>
   <CancelTransferHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </CancelTransferHeader>
</CancelTransferResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=cancel_transfer&domain=domain4.com

Resposta (formato JSON)
{
   "CancelTransferResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Autorização de Transferência (APENAS PARA REVENDA)

Parâmetro de solicitação de transferência autorizada
Explicação
domainApenas 1 domínio pode ser inserido por solicitação para autorizar transferência para longe
order_idO ID do pedido Dynadot do domínio que você deseja transferir para longe
authorizePara autorizar a transferência, defina o valor como "aprovar". Para negar a transferência, defina o valor como "negar".
Tag do resultado em XML
Explicação
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>O root node do documento XML de respostaXML.
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<Result></Result>O resultado da transferência autorizada

Autorizar a transferência de exemplo

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123

Resposta (formato XML)
<AuthorizeTransferAwayResponse>
   <AuthorizeTransferAwayHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
      <Result>away_approved</Result>
   </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123

Resposta (formato JSON)
{
   "AuthorizeTransferAwayResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "Result":"away_approved"
   }
}
 

Criar comando de Auditoria CN

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

Criar parâmetro de solicitação de auditoria CN
Explicação
contact_idO ID do registro do contato para o qual você deseja iniciar a auditoria, apenas 1 IDs de contato podem ser inseridos por solicitação.
contact_typeTipo de contato, pode ser "Individual" ou "Empresa"
individual_id_typeTipo de ID de pessoa natural, valores esperados (descrição do valor) são:
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)
individual_license_idNúmero de licença do documento de identificação da pessoa natural
individual_urlDocumento de identificação de licença de pessoa física. O URL do arquivo no servidor. Somente arquivos 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 (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)
enterprise_license_id (Mandatory when contact type is "Enterprise")Número da licença do documento da empresa
enterprise_url (Mandatory when contact type is "Enterprise")Documento da licença da empresa. URL do arquivo no servidor. Apenas JPG, GIF, PNG, JPEG são permitidos
Tag do resultado em XML
Explicação
<CreateCnAuditResponse></CreateCnAuditResponse>Nó raiz do documento de resposta XML
<CreateCnAuditHeader></CreateCnAuditHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Criar exemplo de auditoria CN

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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)
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
 </CreateCnAuditResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=create_cn_audit&contact_id=testcontactid&license_id=testlicenseid&url=url

Resposta (formato JSON)
{
   "CreateCnAuditResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando Obter Status de Auditoria Cn

Se o comando de status de auditoria get cn for chamado, os seguintes parâmetros devem ser incluídos:

Obter parâmetros de solicitação de status de auditoria Cn
Explicação
contact_idO ID do registro de contato que você deseja obter o status de auditoria, apenas 1 contactId pode ser inserido por solicitação
gtldSe você consultar o resultado da auditoria do cnnic-gtld, defina este parâmetro como 1
Tag do resultado em XML
Explicação
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>O root node do documento XML de respostaXML.
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<CnAuditStatus></CnAuditStatus>O status de auditoria do registro de auditoria da CNNIC. Você pode obter 'processando' ou 'aguardando a CNNIC' ou 'falhou'. Se falhar, enviaremos um e-mail para você.
<FailedReason></FailedReason>Se a auditoria não for aprovada, o motivo do fracasso será exibido

Obter Exemplo de Status de Auditoria Cn

Pedido (formato XML)

https://api.dynadot.xml/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.json/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid

Resposta (formato JSON)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

Comando de Obtenção do Saldo da Conta

Este comando só está disponível no formato XML e JSON:

Obter parâmetro de solicitação de saldo da conta
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<GetAccountBalanceResponse></GetAccountBalanceResponse>O root node do documento XML de respostaXML.
<GetAccountBalanceHeader></GetAccountBalanceHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Conteúdo de resposta
<Balance></Balance>Saldo da Conta

Exemplo de obter o saldo da conta

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=get_account_balance

Resposta (formato JSON)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

Comando de bloqueio de domínio

Se for chamado o comando de bloqueio de domínio, 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, somente um domínio 1 pode ser inserido por solicitação
Tag do resultado em XML
Explicação
<LockDomainResponse></LockDomainResponse>O root node do documento XML de respostaXML.
<LockDomainHeader></LockDomainHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de domínio bloqueado

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=lock_domain&domain=domain4.com

Resposta (formato XML)
<LockDomainResponse>
   <LockDomainferHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=lock_domain&domain=domain4.com

Resposta (formato JSON)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Receber Comandos de Listagens

Se chamando o comando de obtenção de listagens, os seguintes parâmetros devem ser incluídos:

Receber Parâmetros de Pedidos de LIstagem
Explicação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
exclude_pending_sale (opcional)Se você não deseja obter listagens bloqueadas para venda pendente, deve ser "yes",, o padrão é "no".
show_other_registrar (opcional)Se você deseja obter outras listagens de registrador, ela deve ser "yes",, o padrão é "no"
Tag do resultado em XML
Explicação
<GetListingsResponse></GetListingsResponse>O root node do documento XML de respostaXML.
<GetListingsHeader></GetListingsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetListingsContent></GetListingsContent>Conteúdo da listagem
<Listing></Listing>Conteúdo da listagem de itens
<ListingId></ListingId>Id da Listagem
<Domain></Domain>Nome do domínio
<Price></Price>Preço
<InBoundLinks></InBoundLinks>Contagem de links vinculados
<Age></Age>Idade

Receber Exemplos de LIstagens

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&currency=usd&command=get_listings

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>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&currency=usd&command=get_listings

Resposta (formato JSON)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No"
      }
    ]
  }
}
 

Pedir os Comandos de Listagem de Itens

Se estiver chamando o comando para obter um item de listagem, os seguintes parâmetros devem ser incluídos:

Obter parâmetro de solicitação de item de listagem
Explicação
domainO nome de domínio que deseja obter detalhes, apenas um domínio 1 pode ser inserido por solicitação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetListingItemResponse></GetListingItemResponse>O root node do documento XML de respostaXML.
<GetListingItemHeader></GetListingItemHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetListingsItemContent></GetListingsItemContent>Conteúdo da listagem
<Listing></Listing>Conteúdo da listagem de itens
<ListingId></ListingId>Id da Listagem
<Domain></Domain>Nome do domínio
<Price></Price>Preço
<InBoundLinks></InBoundLinks>Contagem de links vinculados
<Age></Age>Idade

Receba um Exemplo de Listagem de Item

Pedido (formato XML)

http://api.dynadot.com/api3.xml?key=my_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>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
Pedido (formato JSON)

http://api.dynadot.com/api3.json?key=my_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"
    }
  }
}
 

Comando de Compra Instantânea

Se o comando buy it now for chamado, os seguintes parâmetros devem ser incluídos:

Parâmetros de Pedido de Compra INstantânea
Explicação
domainO domínio que você deseja comprar, somente 1 domínio pode ser inserido por solicitação
currency (opcional)A moeda de resultado de retorno deve ser "usd", "eur", ou "cny", se nenhuma moeda for inserida, será aplicada a moeda padrão da conta
Tag do resultado em XML
Explicação
<BuyItNowResponse></BuyItNowResponse>O root node do documento XML de respostaXML.
<BuyItNowHeader></BuyItNowHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<Message></Message>Deveria ser "ordem do domínio criada", só usada quando o status é "sucesso".

Exemplo de Compra Instantânea

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=buy_it_now&domain=domain&currency=currency

Resposta (formato XML)
<BuyItNowResponse>
   <BuyItNowHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </BuyItNowHeader>
   <Message>domain order created</Message>
</BuyItNowResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=buy_it_now&domain=domain&currency=currency

Resposta (formato JSON)
{
   "BuyItNowResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "Message":"domain order created"
   }
}
 

Comando de Informações da Conta

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

Parâmetro de Solicitação de Informações da Conta
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<AccountInfoResponse></AccountInfoResponse>Nó raiz do documento de resposta XML
<AccountInfoHeader></AccountInfoHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<AccountInfoContent></AccountInfoContent>Conteúdo de resposta
<AccountInfo></AccountInfo>Informações da conta
<Username></Username>Usuário
<ForumName></ForumName>Nome do fórum
<Contact></Contact>Informações de contato
<Organization></Organization>Empresa
<Organization></Organization>Cabeçalho de resposta
<Name></Name>Seu nome
<Email></Email>E-mail
<PhoneCc></PhoneCc>Código de telefone do país
<PhoneNum></PhoneNum>Número de telefone
<Address1></Address1>Endereço 1
<Address2></Address2>Endereço 2
<City></City>Cidade
<State></State>Estado
<ZipCode></ZipCode>CEP
<Country></Country>País
<CustomerSince></CustomerSince>Cliente desde
<AccountLock></AccountLock>Bloqueio de conta
<TotalSpending></TotalSpending>Total de gasto
<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 de 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

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=account_info

Resposta (formato JSON)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}
 

Definição Padrão de Whois

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

Parâmetro de Solicitação de Definição de Whois Padrão
Explicação
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactAs informações técnicas do domínio
billing_contactAs informações de cobrança do domínio
Tag do resultado em XML
Explicação
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Nó raiz do documento de resposta XML
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Whois Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de Definição de Servidores de Nomes Padrão

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

Parâmetro de Solicitação de Definição de Servidores de Nomes Padrão
Explicação
ns0 - ns12Os servidores de nomes que você deseja definir
Tag do resultado em XML
Explicação
<SetDefaultNsResponse></SetDefaultNsResponse>Marcador da resposta de definição de servidores de nomes padrão. É o nó raiz do documento de resposta XML
<SetDefaultNsHeader></SetDefaultNsHeader>Cabeçalho de definição de servidor de nomes padrão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetDefaultNsContent></SetDefaultNsContent>Marcador de definição de conteúdo padrão dos servidores de nomes, usado apenas quando o status é "success"
<Servers></Servers>As informações dos servidores que você configurou
<Server></Server>Cada servidor
<ServerName></ServerName>Name do servidor
<ServerId></ServerId>ID do servidor

Exemplo de Definição de Servidores de Nomes Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Resposta (formato XML)
<SetDefaultNsResponse>
   <SetDefaultNsHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultNsHeader>
   <SetDefaultNsContent>
      <Servers>
         <Server>
            <ServerName>ns1.hosts.com</ServerName>
            <ServerId>0</ServerId>
         </Server>
         <Server>
            <ServerName>ns2.host.com</ServerName>
            <ServerId>1</ServerId>
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
      </Servers>
   </SetDefaultNsContent>
</SetDefaultNsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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.host.com",
               "ServerId":"1"
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            }
         ]
      }
   }
}
 

Comando de Definição de Estacionamento Padrão

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

Parâmetro de Solicitação de Definição de Estacionamento Padrão
Explicação
with_ads (opcional)Se não quiser anúncios de terceiros, você pode usar este parâmetro com "no",, cujo valor padrão é "yes"
Tag do resultado em XML
Explicação
<SetDefaultParkingResponse></SetDefaultParkingResponse>Nó raiz do documento de resposta XML
<SetDefaultParkingHeader></SetDefaultParkingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Estacionamento Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_parking&folder_id=0&with_ads=no

Resposta (formato XML)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_parking&folder_id=0&with_ads=no

Resposta (formato JSON)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Redirecionamento Padrão

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

Parâmetro de Solicitação de Definição de Redirecionamento Padrão
Explicação
forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"
Tag do resultado em XML
Explicação
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Nó raiz do documento de resposta XML
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com

Resposta (formato XML)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com

Resposta (formato JSON)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Secretividade Padrão

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

Parâmetro de Solicitação de Definição de Secretividade Padrão
Explicação
stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
stealth_title (opcional)O título da página
Tag do resultado em XML
Explicação
<SetDefaultStealthResponse></SetDefaultStealthResponse>Nó raiz do documento de resposta XML
<SetDefaultStealthHeader></SetDefaultStealthHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Definir exemplo padrão de ocultação

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Resposta (formato XML)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Resposta (formato JSON)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Hospedagem Padrão

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

Parâmetro de Solicitação de Definição de Hospedagem Padrão
Explicação
hosting_typeTipo da hospedagem padrão que você deseja. Você pode selecionar "advanced" e "basic"
Tag do resultado em XML
Explicação
<SetDefaultHostingResponse></SetDefaultHostingResponse>Nó raiz do documento de resposta XML
<SetDefaultHostingHeader></SetDefaultHostingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Hospedagem Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_hosting&hosting_type=advanced

Resposta (formato XML)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_hosting&hosting_type=advanced

Resposta (formato JSON)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de DNS Padrão

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

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

Parâmetro de Solicitação de Definição de DNS Padrão
Explicação
main_record_typeTipo principal de registro
main_recordEspecifica um registro DNS para o seu domínio
main_txt (opcional)Especifica um registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado 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 somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (opcional)Registros de subdomínios
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
mx_host0 - mx_host2 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.
mx_distance0 - mx_distance2 (opcional)Distance0 é de prioridade mais alta
ttl (opcional)Tempo de existência
Tag do resultado em XML
Explicação
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nó raiz do documento de resposta XML
<SetDefaultDnsHeader></SetDefaultDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de DNS Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 de definição do DNS2 padrão

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

Definir parâmetro de solicitação de DNS2 padrão
Explicação
main_record_type0 - main_record_type19Tipo principal de registro
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias do e-mail, necessário quando o registro_principal é "a", "aaaa", "cname", "encaminhamento", "txt", "mx", "privado", "e-mail"
subdomain0 - subdomain99 (opcional)Registros de subdomínios
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP do subdomínio ou host de destino
sub_recordx0 - subdo_recordx99Distância mx, tipo de encaminhamento, encaminhamento privado título ou alias de e-mail, necessário quando o sub_registro for "a", "aaaa", "cname", "encaminhamento", "txt", "srv", "mx", "privado", "e-mail"
ttl (opcional)Tempo de existência
Tag do resultado em XML
Explicação
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nó raiz do documento de resposta XML
<SetDefaultDnsHeader></SetDefaultDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de definição do DNS2 padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 Definição de Redirecionamento Padrão de E-mails

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

Parâmetro de Solicitação de Definição de Redirecionamento de E-mails Padrão
Explicação
forward_typeTipo de encaminhamento: pode ser "donot": para não encaminhar e-mail, "mx": para entregar e-mail em outra hospedagem de e-mails (registro MX) ou "forward": entregar e-mail em outra hospedagem de e-mails
username0 - username9Nome de usuário, usado somente quando "forward_type" for "forward".
exist_email0 - exist_email9Endereço de e-mail atual, usado somente quando "forward_type" for "forward".
mx_host0 - mx_host2Hospedagem de e-mails, usado somente quando "forward_type" for "mx".
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado somente quando "forward_type" for "mx".
Tag do resultado em XML
Explicação
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Nó raiz do documento de resposta XML
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento de E-mails Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]

Resposta (formato XML)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]

Resposta (formato JSON)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Configuração de Limpeza Padrão

Ao chamar o comando de definir configurações de limpeza padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Limpeza de Configurações Padrão
Explicação
serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"
Tag do resultado em XML
Explicação
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Nó raiz do documento de resposta XML
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Configuração de Limpeza Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_default_setting&service=nameservers

Resposta (formato XML)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_clear_default_setting&service=nameservers

Resposta (formato JSON)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição das Opções de Renovação Padrão

Ao chamar o comando de definição das opções de renovação padrão, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição das Opções de Renovação Padrão
Explicação
renew_optionPode ser "donot", "auto", "reset"
Tag do resultado em XML
Explicação
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Nó raiz do documento de resposta XML
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição das Opções de Renovação Padrão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_renew_option&renew_option=auto

Resposta (formato XML)
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_renew_option&renew_option=auto

Resposta (formato JSON)
{
   "SetDefaultRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Criação de Pastas

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

Parâmetro de Solicitação de Criação de Pastas
Explicação
folder_nameNome da pasta que você deseja criar
Tag do resultado em XML
Explicação
<FolderCreateResponse></FolderCreateResponse>Nó raiz do documento de resposta XML
<FolderCreateHeader></FolderCreateHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<FolderCreateContent></FolderCreateContent>Conteúdo de resposta
<FolderName></FolderName>nome da pasta
<FolderId></FolderId>ID da nova pasta

Exemplo de Criação de Pastas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=create_folder&folder_name=new

Resposta (formato JSON)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

Comando de exclusão de pasta

Ao chamar o comando de configuração de 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ê quiser deletar, assegure-se de que eles estão separados por vírgulas
Tag do resultado em XML
Explicação
<DeleteFolderResponse></DeleteFolderResponse>Nó raiz do documento de resposta XML
<DeleteFolderHeader></DeleteFolderHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de exclusão de pasta

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_folder&folder_id=0,1

Resposta (formato XML)
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=delete_folder&folder_id=0,1

Resposta (formato JSON)
{
   "DeleteFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de definição de pasta Whois

Se chamar o comando de definição de pasta de Whois, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta de Whois
Explicação
folder_idA ID da pasta que deseja configurar
registrant_contactAs informações do registrante do domínio
admin_contactAs informações do administrador do domínio
technical_contactAs informações técnicas do domínio
billing_contactAs informações de cobrança do domínio
enable (opcional)Se quiser aplicar estas configurações de Whois aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar estas configurações de Whois com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderWhoisResponse></SetFolderWhoisResponse>Nó raiz do documento de resposta XML
<SetFolderWhoisHeader></SetFolderWhoisHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pastas de Whois

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 Definição de Pasta de Servidores de Nomes

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

Parâmetro de Solicitação de Definição de Pasta de Servidores de Nomes
Explicação
fold_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
ns0 - ns12Os servidores de nome definidos para uso do seu domínio. Você pode especificar até 13 servidores de nome, mas eles já devem estar na sua conta
enable (opcional)Se quiser aplicar estas configurações de servidores de nomes aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de definição de servidor de nomes com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderNsResponse></SetFolderNsResponse>Marcador da resposta de definição de pasta de servidor de nomes. É o nó raiz do documento de resposta XML
<SetFolderNsHeader></SetFolderNsHeader>Cabeçalho de resposta de definição de pasta de servidor de nomes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<SetFolderNsContent></SetFolderNsContent>Marcador de definição de conteúdo de resposta da pasta de servidores de nomes, usado apenas quando o status é "success"
<Servers></Servers>As informações dos servidores que você configurou
<Server></Server>Cada servidor
<ServerName></ServerName>Name do servidor
<ServerId></ServerId>ID do servidor

Exemplo de Definição de Servidores de Nomes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Resposta (formato XML)

0 success ns1.hosts.com 0 ns2.host.com 1

Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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.host.com",
               "ServerId":"1"
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            }
         ]
      }
   }
}
 

Comando de Definição de Pasta de Estacionamento

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

Parâmetro de Solicitação de Definição de Pastas de Estacionamento
Explicação
folder_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
with_ads (opcional)Se não quiser anúncios de terceiros, você pode usar este parâmetro com "no",, cujo valor padrão é "yes"
enable (opcional)Se quiser aplicar estas configurações de estacionamento aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de estacionamento de todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderParkingResponse></SetFolderParkingResponse>Nó raiz do documento de resposta XML
<SetFolderParkingHeader></SetFolderParkingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de Estacionamento

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no

Resposta (formato XML)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no

Resposta (formato JSON)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Redirecionamento de Pastas

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

Parâmetro de Solicitação de Definição de Redirecionamento de Pastas
Explicação
folder_idA ID da pasta que deseja configurar
forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"
enable (opcional)Se quiser aplicar estas configurações de redirecionamento aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de redirecionamento com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderForwardingResponse></SetFolderForwardingResponse>Nó raiz do documento de resposta XML
<SetFolderForwardingHeader></SetFolderForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Redirecionamento de Pastas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes

Resposta (formato XML)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes

Resposta (formato JSON)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Secretividade de Pastas

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

Parâmetro de Solicitação de Definição de Pasta com Secretividade
Explicação
folder_idA ID da pasta que você deseja configurar
stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.
stealth_title (opcional)O título da página
enable (opcional)Se quiser aplicar estas configurações aos futuros domínios que mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de redirecionamento secreto com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderStealthResponse></SetFolderStealthResponse>Nó raiz do documento de resposta XML
<SetFolderStealthHeader></SetFolderStealthHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Secretividade de Pastas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes

Resposta (formato XML)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes

Resposta (formato JSON)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Pasta de Hospedagem

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

Parâmetro de Solicitação de Definição de Pasta de Hospedagem
Explicação
folder_idA ID da pasta que deseja configurar
hosting_typeTipo de hospedagem que você deseja. Você pode selecionar "advanced" e "basic"
enable (opcional)Se quiser aplicar estas configurações de hospedagem aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
even (opcional)Se quiser sincronizar as configurações de hospedagem com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderHostingResponse></SetFolderHostingResponse>Nó raiz do documento de resposta XML
<SetFolderHostingHeader></SetFolderHostingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de Hospedagem

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Resposta (formato JSON)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição de Pasta de DNS

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

( Este comando está desatualizado e não é recomendado, use o Comando Configurar DNS2 da Pasta em vez disso )

Definir Parâmetro de Solicitação de Pasta de DNS
Explicação
folder_idA ID da pasta que você deseja definir
main_record_typeTipo principal de registro
main_recordEspecifica um registro DNS para o seu domínio
main_recordEspecifica um registro DNS para o seu domínio
with_ads (opcional)Especifica um registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado 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 somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
mx_host0 - mx_host2 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.
mx_distance0 - mx_distance2 (opcional)Distance0 é de prioridade mais alta
ttl (opcional)Tempo de existência
enable (opcional)Se quiser aplicar estas configurações de DNS aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações do servidor DNS de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderDnsResponse></SetFolderDnsResponse>Nó raiz do documento de resposta XML
<SetFolderDnsHeader></SetFolderDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de DNS

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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"
   }
}
 

Definir comando da pasta DNS2

Ao fazer o comando de determinada pasta DNS2, os seguintes parâmetros devem ser inclusos:

Parâmetro de definição de solicitação de pasta DNS2
Explicação
folder_idA 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, encaminhamento privado, título ou alias de e-mail quando o registro_principal é "encaminhado" "mx", "privado", "e-mail"
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Os registros de subdomínio devem ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo
sub_recordx0 - sub_recordx99 (opcional)Distância Mx, tipo de encaminhamento, encaminhamento privado ou alias do e-mail, necessário quando o tipo_desub_registro for "encaminhamento","mx","privado","e-mail"
ttl (opcional)Tempo de existência
enable (opcional)Se quiser aplicar estas configurações de DNS aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações do servidor DNS de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderDnsResponse></SetFolderDnsResponse>Nó raiz do documento de resposta XML
<SetFolderDnsHeader></SetFolderDnsHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Definir exemplo de pasta DNS2

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Resposta (formato XML)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 Definição de Pasta para Redirecionamento de E-mails

Ao chamar o comando de definição de pasta de redirecionamento de e-mails, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Pasta para Redirecionamento de E-mails
Explicação
domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas
folder_idID da pasta que você deseja definir
forward_typeTipo de encaminhamento: pode ser "donot": para não encaminhar e-mail, "mx": para entregar e-mail em outra hospedagem de e-mails (registro MX) ou "forward": entregar e-mail em outra hospedagem de e-mails
username0 - username9Nome de usuário, usado somente quando "forward_type" for "forward".
exist_email0 - exist_email9Endereço de e-mail atual, usado somente quando "forward_type" for "forward".
mx_host0 - mx_host2Hospedagem de e-mails, usado somente quando "forward_type" for "mx".
mx_distance0 - mx_distance2Distance0 é a prioridade mais alta, usado somente quando "forward_type" for "mx".
enable (opcional)Se quiser aplicar estas configurações aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar estas configurações com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Nó raiz do documento de resposta XML
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Pasta de Redirecionamento de E-mails

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]

Resposta (formato XML)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]

Resposta (formato JSON)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Solicitação de Definição de Configuração de Limpeza de Pasta

Ao chamar o comando de configuração de limpeza de pasta, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Configuração de Limpeza de Pasta
Explicação
folder_idA ID da pasta que deseja configurar
serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"
Tag do resultado em XML
Explicação
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nó raiz do documento de resposta XML
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Configuração de Limpeza de Pastas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers

Resposta (formato XML)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers

Resposta (formato JSON)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição do Nome de Pastas

Ao chamar o comando de definição do nome das pastas, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição de Nomes de Pastas
Explicação
folder_idID da pasta que você deseja configurar
folder_nameNome da nova pasta
Tag do resultado em XML
Explicação
<SetFolderNameResponse></SetFolderNameResponse>Nó raiz do documento de resposta XML
<SetFolderNameHeader></SetFolderNameHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Definição de Nomes de Pastas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_name&folder_id=0&folder_name=new

Resposta (formato XML)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_name&folder_id=0&folder_name=new

Resposta (formato JSON)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Definição da Pasta de Opções de Renovação

Ao chamar o comando de definição de pasta das opções de renovação, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Definição da Pasta de Opões de Renovação
Explicação
folder_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação
renew_optionA opção de renovação que deseja definir para a pasta; pode ser "não renovar", "renovação automática" ou "redefinir".
enable (opcional)Se quiser aplicar estas configurações de renovação aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"
sync (opcional)Se quiser sincronizar as configurações de renovação com todos os domínios desta pasta, você pode usar este parâmetro com "yes"
Tag do resultado em XML
Explicação
<Response></Response>Nó raiz do documento de resposta XML
<ResponseHeader></ResponseHeader>Cabeçalho de Resposta
<ResponseCode></ResponseCode>Código de resposta: "0" em caso de sucesso, "-1" se houver falhado
<Error></Error>Informação de erro, usado somente quando o código de resposta for "-1"

Exemplo de Definição das Pastas de Opções de Renovação

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_renew_option&folder_id=0&renew_option=auto

Resposta (formato XML)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_renew_option&folder_id=0&renew_option=auto

Resposta (formato JSON)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Listagem de Pastas

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

Parâmetro de Solicitação de Listagem de Pastas
Explicação
N/ANenhum parâmetro extra é necessário
<FolderListResponse></FolderListResponse>Nó raiz do documento de resposta XML
<FolderListHeader></FolderListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<FolderListContent></FolderListContent>Conteúdo de 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 habilitação do Whois padrão
<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 habilitado de servidor de nomes padrão
<NameServerSettings></NameServerSettings>Configurações de servidores de nomes
<Type></Type>Tipo de servidor de nomes
<WithAds></WithAds>Com anúncios ou não
<DefaultRenewOption></DefaultRenewOption>Opção padrão de renovação
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Status de habilitação padrão das opções de renovação
<RenewOption></RenewOption>Opção de renovação
<DefaultTransferLock></DefaultTransferLock>Bloqueio de transferências padrão
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Status de habilitação padrão do bloqueio de transferências
<LockStatus></LockStatus>Status de bloqueio

Exemplo de Listagem de Pastas

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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"
        }
      }
    ]
  }
}
 

Comando de Adição de Solicitação de Domínios Pendentes

Ao chamar o comando de adição de solicitação de domínios pendentes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Adição de Solicitação de Domínios Pendentes
Explicação
domainO(s) domínio(s) que você deseja adicionar e comprar caso o Dynadot o(s) obtenha. 100 podem ser adicionados por solicitação e devem ser separados por vírgulas.
Tag do resultado em XML
Explicação
<AddBackorderRequestResponse></AddBackorderRequestResponse>Nó raiz do documento de resposta XML
<AddBackorderRequestHeader></AddBackorderRequestHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Adição de Solicitação de Domínios Pendentes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Resposta (formato XML)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Resposta (formato JSON)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Exclusão da Solicitação de Domínios Pendentes

Ao chamar o comando de exclusão de solicitação de domínios pendentes, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Exclusão de Solicitação de Domínios Pendentes
Explicação
domainO(s) domínio(s) que você deseja remover da sua lista de solicitação de domínios pendentes. 100 domínios podem ser removidos por solicitação e devem ser separados por vírgulas
Tag do resultado em XML
Explicação
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Nó raiz do documento de resposta XML
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Exclusão de Solicitação de Domínios Pendentes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_backorder_request&domain=domaindropp.com

Resposta (formato XML)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=delete_backorder_request&domain=domaindropp.com

Resposta (formato JSON)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de Listagem de Solicitação de Domínios Pendentes

Chamar o comando de solicitação de lista de domínios pendentes retornará uma lista de domínios pendentes da conta especificada. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Lista de Solicitação de Domínios Pendentes
Explicação
startDateData de início do leilão de domínio pendentes que você deseja solicitar, aaaa-mm-dd, como 2015-05-25
endDateData de encerramento do leilão de domínio pendentes que você deseja solicitar, aaaa-mm-dd, como 2015-05-25
Tag do resultado em XML
Explicação
<BackorderRequestListResponse></BackorderRequestListResponse>Nó raiz do documento de resposta XML
<BackorderRequestListHeader></BackorderRequestListHeader>Cabeçalho de resposta
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<BackorderRequestListContent></BackorderRequestListContent>Conteúdo de resposta
<BackorderRequestList></BackorderRequestList>Lista de Solicitação de Domínios Pendentes
<BackorderRequest></BackorderRequest>Solicitação de domínios pendentes
<Domain></Domain>Domínios na sua lista
<CutoffTime></CutoffTime>Data limite para excluir uma solicitação em tempo Unix (milissegundos desde a meia-noite UTC de 1 janeiro de 1970)
<BackorderRequestStatus></BackorderRequestStatus>Status do processo de obtenção de domínios pendentes

Exemplo de Listagem de Solicitações de Domínios Pendentes

Pedido (formato XML)

http://api.dynadot.com/api3.xml?key=1&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>
Pedido (formato CSV)

http://api.dynadot.com/api3.html?key=1&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
Pedido (formato JSON)

http://api.dynadot.com/api3.json?key=1&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"
      }
    ]
  }
}
 

Comando de Obtenção de Leilões Abertos

Chamar o comando de obtenção de leilões abertos retornará uma lista de leilões que estão em andamento. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Obtenção de Leilões Abertos
Explicação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
typeO tipo de leilão que você deseja ver deve ser "expired", "user", "backorder", ou "registry_expired",. Se você quiser ver mais de um tipo de leilão, pode usar "," para separar cada tipo de leilão.
Tag do resultado em XML
Explicação
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Marcador da resposta de obtenção de leilões abertos. É o nó raiz do documento de resposta XML
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Cabeçalho de leilões abertos
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Marcador de obtenção de conteúdo de leilões abertos, usado apenas quando o status é "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Revenue></Revenue>Receita de 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 Obtenção de Leilões Abertos

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=get_open_auctions&currency=usd&type=expired

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>
Solicitação (formato csv)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions&currency=usd&type=expired

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

Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=get_open_auctions&currency=usd&type=expired

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,
            "estibot_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,
            "estibot_appraisal": "-"
        }
        ...
    ]
}
 

Comando de Obtenção de Detalhes do Leilão

Chamar o comando obter detalhes do leilão 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 de Obtenção de Detalhes de Leilão
Explicação
domainO nome de domínio de 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 dividido por ","
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Marcador da resposta de obtenção de detalhes de leilão. É o nó raiz do documento de resposta XML
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho das informações do leilão de domínios pendentes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Marcador de obtenção de detalhes do conteúdo de leilão, usado somente quando o status for "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 em renovação, '4' para Concluído, '5' para Cancelado pela transferência
<AuctionStatus></AuctionStatus>Status do leilão
<UserIsHighBid></UserIsHighBid>Se o usuário deu o maior lance
<YourCurrentBid></YourCurrentBid>Seu preço atual de lance para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'
<YourProxyBid></YourProxyBid>Seu lance automático para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde 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 Obtenção de Detalhes de Leilão

Pedido (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>
Pedido (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": "",
        "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 de Colocação de Lance no Leilão

Chamar o comando de lance em leilão colocará um lance no leilão especificado. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Colocação de Lance em Leilão
Explicação
domainO nome de domínio de leilão e o IDN (Nome de Domínio Internacionalizado) devem usar um punycode como "xn--wkccg.com"
bid_amountO valor do seu lance para leilão. A moeda padrão é o Dólar Americano. Você pode especificar isso no parâmetro de moeda abaixo
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Marcador de resposta de colocação de lance no leilão, é o nó raiz do documento XML de resposta
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Coloca cabeçalho de lance no leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de domínio

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Solicitação (formato csv)

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

Resposta

ok,success

Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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,
            "estibot_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 de Obtenção de Leilões Encerrados

Chamar o comando de obtenção de leilões encerrados retornará uma lista de leilões encerrados da conta especificada. Ao 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
startDateData de início do leilão, aaaa-mm-dd, como 2015-05-25
endDateData de encerramento do leilão, aaaa-mm-dd, como 2015-05-25
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Marcador da resposta de obtenção de leilões encerrados. É o nó raiz do documento de resposta XML
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Cabeçalho de obtenção de leilões encerrados
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Marcador de obtenção de detalhes do conteúdo de leilão encerrado, usado somente quando o status for "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "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, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência
<AuctionStatus></AuctionStatus>Status do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<AuctionWonStatus></AuctionWonStatus>Se o usuário venceu este leilão
<YourHighBid></YourHighBid>Seu lance mais alto neste leilão
<YourProxyBid></YourProxyBid>Seu lance automático para este leilão

Exemplo de Obtenção de Leilões Encerrados

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=1&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>
Pedido (formato CSV)

https://api.dynadot.com/api3.html?key=1&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
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=1&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"
      }
    ]
  }
}
 

Comando para obtenção de leilões abertos de domínios pendentes(Descontinuado, por favor use o comando get_open_auctions)

Chamar o comando de obtenção de leilões abertos de domínios pendentes retorna uma lista de leilões de domínios pendentes que estão em progresso. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação para obtenção de leilões abertos de domínios pendentes
Explicação
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Tag para obtenção de resposta dos leilões abertos de domínios pendentes, é o nó raiz do documento XML de resposta
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Cabeçalho de obtenção de leilão aberto de domínios pendentes
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag para obtenção de conteúdo dos leilões abertos de domínios pendentes, só é usado quando o status é "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<AuctionId></AuctionId>ID do leilão
<Domain></Domain>Nome de Domínio do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)

Exemplo de obtenção de leilões abertos de domínios pendentes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Solicitação (formato csv)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions&currency=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 as informações do leilão de domínios pendentes

A chamada do comando de detalhes do leilão de reserva devolverá os detalhes do leilão especificado. Este comando só está disponível nos formatos XML e JSON. Ao chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de Obtenção de Detalhes de Leilão
Explicação
domainO nome de domínio do leilão de domínios pendentes, IDN (Nome de domínio internacionalizado) deve usar punycode, como "xn--wkccg.com"
currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano
Tag do resultado em XML
Explicação
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Marcador da resposta de obtenção de detalhes de leilão. É o nó raiz do documento de resposta XML
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho de obtenção de detalhes do leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Marcador de obtenção de detalhes do conteúdo de leilão, usado somente quando o status for "success"
<AuctionStatusId></AuctionStatusId>Id de status do leilão: '0' para em andamento, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência
<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 de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão
<EndTime></EndTime>Tempo de encerramento do leilão
<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)
<Revenue></Revenue>Receita de 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 deu o maior lance
<YourCurrentBid></YourCurrentBid>Seu preço atual de lance para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'
<YourProxyBid></YourProxyBid>Seu lance automático para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'

Exemplo de informações do leilão de domínios pendentes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&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 colocação de lance no leilão de domínios pendentes

Chamar o comando de lance no leilão de domínios pendentes coloca um lance em leilão específico. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de lance no leilão de domínios pendentes
Explicação
domainO nome de domínio de leilão e o IDN (Nome de Domínio Internacionalizado) devem usar um punycode como "xn--wkccg.com"
bid_amountO valor do seu lance para leilão. A moeda padrão é o Dólar Americano. Você pode especificar isso no parâmetro de moeda abaixo
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Marcador de resposta de colocação de lance no leilão, é o nó raiz do documento XML de resposta
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Coloca cabeçalho de lance no leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de lance no leilão de domínios pendentes

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&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>
Pedido (formato CSV)

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

Resposta (formato CSV)
ok,success
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Resposta (formato JSON)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Comando de obtenção de leilão fechado de domínios pendentes

Chamar o comando de obtenção de leilões fechados de domínios pendentes retorna uma lista de leilões fechados específicos para uma conta. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro para obter as solicitações do leilão encerrado de domínios pendentes
Explicação
startDateData de início do leilão, aaaa-mm-dd, como 2015-05-25
endDateData de encerramento do leilão, aaaa-mm-dd, como 2015-05-25
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Marcador da resposta de obtenção de leilões encerrados. É o nó raiz do documento de resposta XML
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Cabeçalho de obtenção de leilões encerrados
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Marcador de obtenção de detalhes do conteúdo de leilão encerrado, usado somente quando o status for "success"
<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"
<YourHighBid></YourHighBid>Seu lance mais alto neste leilão
<YourProxyBid></YourProxyBid>Seu lance automático 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, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência
<AuctionStatus></AuctionStatus>Status do leilão
<BidPrice></BidPrice>Preço de lance do leilão atual
<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance
<Bids></Bids>Contagem de lances no leilão

Obter Exemplo de Leilões de Backorder Fechados

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=1&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>
Pedido (formato CSV)

https://api.dynadot.com/api3.html?key=1&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
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=1&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"
      }
    ]
  }
}
 

Comando para obter lances do leilão

Chamar o comando de obter lances de leilão irá buscar sua lista de lances nos quais você participou. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Obter parâmetros de solicitação de lances de leilão
Explicação
currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.
Tag do resultado em XML
Explicação
<GetAuctionBidsResponse></GetAuctionBidsResponse>Tag de resposta de lances de leilão recebidos, é o nó raiz do documento de resposta XML
<GetAuctionBidsHeader></GetAuctionBidsHeader>Obter cabeçalho de lances em leilão
<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado
<Status></Status>Status da solicitação
<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"
<GetAuctionBidsContent></GetAuctionBidsContent>Tag do conteúdo das ofertas de leilão obtidas, é usado somente quando o status é "success"
<BidList></BidList>Lista de lances
<Bid></Bid>Item de Licitação
<BidId></BidId>ID do lance
<AuctionId></AuctionId>ID do leilão
<AccountId></AccountId>Identificação da conta
<Domain></Domain>Nome de Domínio do leilão
<DomainUtf></DomainUtf>Nome utf do leilão de domínio
<AuctionType></AuctionType>Tipo de leilão
<IsIdn></IsIdn>Se este domínio for um Nome de Domínio Internacionalizado
<CurrentBid></CurrentBid>Preço atual da oferta para o leilão
<YourStatus></YourStatus>O status da sua oferta para o leilão
<ProxyBid></ProxyBid>Seu lance de procurador para o leilão
<ActiveBidders></ActiveBidders>A quantidade de licitantes que participam deste leilão
<TimeLeft></TimeLeft>tempo restante para o leilão
<EndTime></EndTime>Tempo limite para o leilão
<EndTimestamp></EndTimestamp>O carimbo de data e hora final para o leilão

Exemplo de obtenção de lances do leilão

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=get_auction_bids&currency=usd

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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=mykey&command=get_auction_bids&currency=usd

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 em processamento (is processing)

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

Parâmetro de Solicitação de em Processamento
Explicação
nenhum parâmetro adicional é necessário
Tag do resultado em XML
Explicação
<Response></Response>Marcador de resposta de is_processing
<RespnseHeader></RespnseHeader>Cabeçalho de is_processing
<ResponseMsg></ResponseMsg>Marcador da mensagem de resposta de is_processing. Deve ser "sim" (há um processo no sistema, você não deve enviar outra solicitação) ou "não" (não há nenhum processo na sua conta, é seguro enviar uma nova solicitação).

Exemplo de em Processamento

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=mykey&command=is_processing

Resposta (formato XML)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Pedido (formato CSV)

http://api.dynadot.com/api3.html?key=mykey&command=is_processing

Resposta (formato CSV)
ok,yes
Pedido (formato JSON)

http://api.dynadot.com/api3.html?key=mykey&command=is_processing

Resposta (formato JSON)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
 

Obter comando de domínios de liquidação expirados

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

Obter parâmetro de solicitação de domínios de liquidação expirados
Explicação
currency(optional)A moeda do resultado de retorno deve ser "usd", "eur", ou "cny", a moeda padrão é o dólar dos Estados Unidos.
domain(optional)Adicione esse parâmetro se quiser consultar um domínio de liquidação
Tag do resultado em XML
Explicação
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Tag de resposta de Domínios expirados de liquidação, é o nó raiz da resposta do documento XML
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Obter Cabeçalho de Domínios de Fechamento Vencidos
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag de conteúdo, só é usada quando o status é 'sucesso'
<CloseoutItem></CloseoutItem>Liquidação
<DomainName></DomainName>O nome de domínio
<DomainNameUtf></DomainNameUtf>O nome de domínio está no 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 fechamento
<EstibotAppraisal></EstibotAppraisal>AvaliaçãoEstibot
<InboundLinks></InboundLinks>Links de entrada do domínio
<MonthlyVisitors></MonthlyVisitors>Visitantes do domínio
<Currency></Currency>moeda

Obtenha exemplos de domínios de fim de estoque expirados

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=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 de fechamento expirado

Chamar o Comando Buy Expired Closeout Domain comprará o nome de domínio especificado. Este comando só está disponível em formato XML e JSON. Se chamar este comando, devem ser incluídos os seguintes parâmetros:

Comprar parâmetro de Solicitação de Domínio de Liquidação Expirado
Explicação
domainO domínio que você deseja comprar, somente 1 domínio pode ser inserido por solicitação
currency(optional)A moeda do resultado de retorno deve ser "usd", "eur", ou "cny", a moeda padrão é o dólar dos Estados Unidos.
Tag do resultado em XML
Explicação
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Tag de Compra Encerrada de Domínio Expirado, é o nó raiz do documento XML de resposta.
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Comprar cabeçalho de domínio de liquidação expirado
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Comprar domínio de fechamento expirado (exemplo)

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain¤cy=USD&domain=domain.com

Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain¤cy=USD&domain=domain.com

Resposta (formato JSON)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Definir Comando de Confirmação do Afternic

Chamar o comando Set Afternic Confirm Action comprará o nome de domínio especificado. 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 confirmação de ação Afternic
Explicação
domainO domínio que você deseja definir requer ação de confirmação Afternic, apenas 1 domínio pode ser inserido por solicitação
actionA ação que você deseja definir após a confirmação da afternic deve ser "confirm_afternic" ou "delete_from_afternic".
Tag do resultado em XML
Explicação
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Tag de confirmação de ação Afternic Set, é o nó raiz da resposta XML do documento.
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Definir cabeçalho de ação de confirmação Afternic
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Definir Exemplo de Ação de Confirmação Afternic

Pedido (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>
Pedido (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 da Sedo

Chamar o comando de ação de confirmação do Sedo Set comprará o nome de domínio especificado. Este comando está disponível apenas em formato 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 da Sedo
Explicação
domainO domínio que deseja definir a ação de confirmação da Sedo, apenas 1 domínio pode ser inserido por solicitação
actionA ação que você deseja definir sedo confrim para, deve ser "confirm_sedo" ou "delete_from_sedo"
Tag do resultado em XML
Explicação
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Tag da resposta de confirmação da ação do Set Sedo, é o nó raiz do documento de resposta XML
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>Definir cabeçalho de ação de confirmação Sedo
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

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

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_sedo

Resposta (formato JSON)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Comando de Lista de Pedidos

Chamar o comando de lista de pedidos obterá a lista de pedidos. Este comando está disponível apenas nos formatos XML e JSON. Se for chamado esse comando, os seguintes parâmetros devem ser incluídos.

Parâmetro de solicitação de lista de pedidos
Explicação
search_byVocê pode escolher um valor da seguinte lista para representar seu tipo de pesquisa: date_range
domínio
order_id
start_datea data de início da sua consulta no formato yyyy/MM/dd
end_datea data de término da sua consulta no formato aaaa/MM/dd
payment_methodVocê pode escolher vários valores da seguinte lista para representar seu método de pagamento: none_balance account_balance credit_card money_order paypal moneybookers bank_wire alipay payflow_credit_card2 (Não mais usado) wechat_pay ecash bank_transfer apple_pay checking_account sale union_pay paypal_account mercado_pago payoneer mas por favor, use vírgula para separar múltiplos valores, por exemplo: account_balance,credit_card.
Tag do resultado em XML
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>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"
<OrderListContent></OrderListContent>Cabeçalho da lista de pedidos
<OrderList></OrderList>Contém vários conjuntos de dados de registro de pedidos
<OrderItem></OrderItem>Contém dados de registro de pedido único
<OrderItemDomain></OrderItemDomain>O nome de domínio que inclui os itens nesta ordem
<OrderId></OrderId>Contém o ID do pedido
<SubmittedDate></SubmittedDate>Contém a data em que o pedido foi enviado
<Cost></Cost>Contém o custo do pedido
<Status></Status>Contém o status do pedido

Exemplo de Lista de Pedidos

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=0&searchBy=date_range&startDate=2024/01/01&endDate=2024/01/31&paymentMethod=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>1714159362467</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>1714159362467</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=0&command=order_list&searchBy=date_range&startDate=2024/01/01&endDate=2024/01/31&paymentMethod=account_balance,credit_card

Resposta (formato JSON)
{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2024/04/26",
        "Currency": "USD",
        "PaymentMethod": "Account Balance",
        "TotalCost": "$8.00",
        "TotalPaid": "$8.00",
        "Status": "Problem",
        "ItemList": [
          {
            "ItemType": "Domain Registration",
            "Name": "test.com",
            "Duration": 1,
            "Cost": "2.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test1.ac",
            "Duration": 1,
            "Cost": "3.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test2.de",
            "Duration": 1,
            "Cost": "4.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Registration",
            "Name": "test3.gg",
            "Duration": 1,
            "Cost": "5.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test4.uk",
            "Duration": 1,
            "Cost": "6.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test5.net",
            "Duration": 1,
            "Cost": "7.99",
            "Status": "Completed"
          }
        ]
      },
      {
        "OrderId": "123457",
        "SubmittedDate": "2024/04/26",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}
 

Comando de Configuração de DNSSEC de Domínio

Chamar o comando de Definição de domínio De dnssec irá definir dnssec 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:

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

Opção 1: domainName, keyTag, digestType, digest, Algorithm

Opção 2: nomeDoDomínio, indicadores, chavePública, Algoritmo

Notas: Por favor, selecione o número da etiqueta correspondente como o valor do seu parâmetro, se houver.

Parâmetro de solicitação de Dnssec do domínio definido
Explicação
domainNameO nome de domínio para o qual você precisa configurar o dnssec
keyTagChaveiro
digestTypeVocê pode escolher um número da seguinte lista para representar o tipo de assinatura digital: SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)
digestDigest.
AlgorithmVocê pode escolher um número da seguinte lista 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) ECDSA Curva P-256 com SHA-256(13 ECDSA Curva 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)
publicKeyA chave pública deve estar na codificação base64.
Tag do resultado em XML
Explicação
<SetDomainDnssecResponse></SetDomainDnssecResponse>O nó raiz da resposta
<SetDomainDnssecHeader></SetDomainDnssecHeader>Definir cabeçalho DNSSEC do domínio
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Exemplo de configuração de DNSSEC de domínio

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=0&command=set_domain_dnssec&domainName=domain-haha1.com&flags=257&publicKey=123&algorithm=1

Resposta (formato XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainDnssecResponse>
  <SetDomainDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainDnssecHeader>
  <SetDomainDnssecContent/>
</SetDomainDnssecResponse>
Pedido (formato JSON)

https://api.dynadot.com/api3.xml?key=0&command=set_domain_dnssec&domainName=domain-haha1.com&flags=257&publicKey=123&algorithm=1

Resposta (formato JSON)
{
  "SetDomainDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Obter comando de estatísticas do Whois

Chamar o comando Obter Estatísticas do Whois irá obter estatísticas do Whois. Este comando só está disponível nos formatos XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Obter parâmetro de solicitação de estatísticas do Whois
Explicação
domainNameO nome de domínio para o qual você precisa configurar o dnssec
dateTypeVocê pode escolher um número da seguinte lista para representar o tipo de data: Últimos 7 dias (1) Últimos 30 dias (2) Último ano (3) Ano atual (4)
Tag do resultado em XML
Explicação
<GetWhoisStatsResponse></GetWhoisStatsResponse>O nó raiz da resposta
<GetWhoisStatsHeader></GetWhoisStatsHeader>Obter cabeçalho de estatísticas do Whois
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"
<GetWhoisStatsContent></GetWhoisStatsContent>conteúdo de resposta
<WhoisStats></WhoisStats>Contém múltiplos conjuntos de dados estatísticos de whois
<WhoisStat></WhoisStat>Dados estatísticos específicos do Whois
<Date></Date>Intervalo de tempo mínimo
<Count></Count>Contagem de whois dentro do intervalo de tempo atual

Exemplo de estatísticas do Whois

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=0&command=get_whois_stats&domainName=domain1.com&dateType=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>
Pedido (formato JSON)

https://api.dynadot.com/api3.json?key=0&command=get_whois_stats&domainName=domain1.com&dateType=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 para obter o status do pedido

Chamar o comando de Pedido de Obter Status obterá o status do pedido. Este comando está disponível apenas no formato XML e JSON. Se chamar este comando, os seguintes parâmetros devem estar incluídos:

Parâmetro de solicitação de status do pedido
Explicação
order_idO ID do pedido a ser consultado
Tag do resultado em XML
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>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"
<GetOrderStatusContent></GetOrderStatusContent>conteúdo de resposta
<OrderId></OrderId>ID do pedido
<OrderStatus></OrderStatus>status do pedido (compra, enviado, aguardando pagamento, processando, concluído, problema, excluído, cancelado)
<ItemTypeName></ItemTypeName>Tipo de item
<ItemName></ItemName>Nome do item
<ItemStatus></ItemStatus>Estado do item (Concluído, Cancelado, Problema)

Obter exemplo de status do pedido

Pedido (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>
Pedido (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 solicitação de empurrão de domínio

Chamar o comando Get Domain Push Request recebe a solicitação de push do domínio. Este comando só está disponível nos formatos XML e JSON.

Obter parâmetro de solicitação de push de domínio
Explicação
N/ANenhum parâmetro extra é necessário
Tag do resultado em XML
Explicação
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>O nó raiz da resposta
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>Obter cabeçalho de solicitação de push de domínios
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"
<GetDomainPushRequestContent></GetDomainPushRequestContent>conteúdo de resposta
<PushDomain></PushDomain>Push de domínio
<PushDomainName></PushDomainName>Empurrar Nome de Domínio

Obter exemplo de solicitação de push de domínio

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=0&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.xml?key=0&command=get_domain_push_request

Resposta (formato JSON)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

Comando de solicitação de push de domínio definido

Chamar o comando de solicitação de envio de domínio definirá a solicitação de envio 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 envio 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 'aceitar' ou 'recusar'.
Tag do resultado em XML
Explicação
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>O nó raiz da resposta
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>Definir cabeçalho de solicitação de push de domínio
<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha
<Status></Status>Status da solicitação
<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

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

Pedido (formato XML)

https://api.dynadot.com/api3.xml?key=0&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>
Pedido (formato JSON)

https://api.dynadot.com/api3.xml?key=0&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"
  }
}
Tem certeza de que deseja encerrar o bate-papo?O bate-papo será fechado e o histórico de bate-papo será apagado.
continuar a sair
ou permanecer no chat.
Para revisar esta sessão de chat, por favorcliqueesta janela
Chat Online
Chat Online0