API Avançada de Domínios

Advanced Domain API from Dynadot - Manage Domains with Your Own Software

Looking for more features from our Domain API? Look no further than our Advanced Domain API. This version of our API allows you to use your own software and servers to do over 50 commands including create folders, set Whois, set privacy, set email forwarding, and more! Our Advanced Domain API is available to all accounts, so get started today by following the directions below.

Looking for a more simple way to use our API? Check out our Domain API page!

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

Requests to our Advanced Domain API are sent to the following URL:

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

Observe que as solicitações devem ser enviadas via https (soquete seguro) por segurança. Apenas 1 solicitação pode ser processada por vez, então aguarde a conclusão da solicitação atual antes de enviar outra. A solicitação deve ter os seguintes parâmetros:

Parâmetro de Solicitação
Explicação
KeySua chave para acessar a API, disponível no seu painel de controle.

Nossa API Avançada de Domínios retornará os resultados em um formato XML. Sua solicitação deve conter 2 ou 3 dos seguintes campos:

Nome da tag 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 - domain99The domain name you are searching for, regular account can specify 1 domain per command, bulk and super bulk account can specify up to 100 domains
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".
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

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1

Resposta
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Status>success</Status>
      <Available>yes</Available>
      <Price>10.99 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Status>success</Status>
      <Available>yes</Available>
      <Price>9.99 in USD</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
 

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.
option0 (se necessário)O nome do registrador ou da organização de .UK
O nome do titular do registro .AT, .BE, .LT, ou .PH.
option1 (se necessário)A organização titular das extensões .AT, .BE, .LT, ou .PH (opcional)
Para .AT, você pode especificar option0, option1, ou ambos
option2 (se necessário)O código da organização .LT
premium (opcional)If you want to regist a premium domin, set it equal to "1" (optional)
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

Solicitação

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

Resposta
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
 

Comando de Exclusão

Calling the delete command will delete a domain that is still in the grace period. Your account balance will be credited back the registration fee. Domains that have been renewed, or that have been moved to a new account cannot be deleted through the API. If calling the delete command, the following parameters should be included:

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

Solicitação

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

Resposta
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
 

Comando de Renovação

Calling the renew command will create and process a renewal order. You must have enough account balance to pay for the order. If calling the renew command, the following parameters should be included:

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

Solicitação

https://api.dynadot.com/api3.xml?key=50&domain=domian1.com&command=renew&duration=1

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

Comando de Informações de Domínios

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

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
<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"
<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)
<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

Solicitação

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

Resposta
<DomainInfoResponse>
  <DomainInfoResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DomainInfoResponseHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1370056762789</Expiration>
      <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></Note>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
 

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

Solicitação

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
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
 

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

Solicitação

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
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
 

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

Solicitação

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

Resposta

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

 

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_urlThe URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
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

Solicitação

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

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

 

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_urlThe URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
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

Solicitação

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

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

 

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

Solicitação

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

Resposta

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

 

Comando de Definição de DNS

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

( This command is outdate and not recommended, please use Set DNS2 Command instead )

Parâmetro de Solicitação de Definição de DNS
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_typeTipo principal de registro
main_recordEspecifica um registro DNS para o seu domínio
main_txt1 - main_txt4 (opcional)Especifica 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 - subdomain20 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type20 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record20 (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
<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"

Exemplo de Definição de DNS

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns&domain=domain1.com&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Resposta

<SetDnsResponse><SetDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDnsHeader></SetDnsResponse>

 

Definir comando DNS2

If calling set DNS2 command, the following parameters should be included:

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_type19Main record type, should be "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Mx distance, forward type, stealth forward title or email alias, necessary when main_record_type is "forward","mx","stealth","email"
subdomain0 - subdomain49 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type49Subdomain record type, should be "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record49Endereço IP do subdomínio ou host de destino
sub_recordx0 - sub_recordx49Mx distance, forward type, stealth forward title or email alias, necessary when main_record_type is "forward","mx","stealth","email"
ttl (opcional)Tempo de existê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"

Definir exemplo de DNS2

Solicitação

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

<SetDnsResponse><SetDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDnsHeader></SetDnsResponse>

 

Comando de Definição de Hospedagem Gratuita

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

Parâmetro de Solicitação de Definição de Hospedagem Gratuita
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
style (opcional)O estilo da página gratuita
titleO título da página gratuita
bodyA parte principal da página. HTML é permitido, mas as seguintes tags não devem ser incluídas: <html>,<title>, <body>, <meta>, <script>; note que qualquer HTML inserido no corpo não será validado
Tag do resultado em XML
Explicação
<SetFreeHostResponse></SetFreeHostResponse>Marcador da resposta de definição de hospedagem gratuita. É o nó raiz do documento de resposta XML
<SetFreeHostHeader></SetFreeHostHeader>Cabeçalho de definição de hospedagem gratuita
<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 Gratuita

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_free_hosting&domain=domain1.com,domain2.com&title=Obama's shop&body=<div>this is obama's shop</div>

Resposta

<SetFreeHostResponse><SetFreeHostHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFreeHostHeader></SetFreeHostResponse>

 

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

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&exist_email0=Alex@dynadot.com

Resposta

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

 

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 deseja excluir. Pode ser "forward", "stealth", "email_forwarding", "free_hosting", "dns" 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

Solicitação

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

Resposta

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

 

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

Solicitação

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

Resposta

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

 

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

Solicitação

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

Resposta

<SetRenewOptionResponse><SetRenewOptionHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetRenewOptionHeader></SetRenewOptionResponse>

 

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

Solicitação

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

Resposta

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

 

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

Solicitação

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

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

Comando de Listagem dos Domínios

Este recurso só está disponível no formato XML:

Parâmetro de Solicitação de Listagem de Domínios
Explicação
N/ANenhum parâmetro extra é necessário
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)
<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

Solicitação

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

Resposta
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <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>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note></Note>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
      <DomainInfo>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <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>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note></Note>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInforList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
 

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
stateEstado
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>&lt;ContactId&gt;ID do Novo Contato&lt;/ContactId&gt;,, usado somente quando for "success".

Exemplo de Criação de Contatos

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=create_contact&name=Webb&email=myemail@email.com&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US

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

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

Exemplo de Edição de Contatos

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=edit_contact&contact_id=0&name=Webb&email=myemail@email.com&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Resposta
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
 

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

Solicitação

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

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

Comando de Listagem dos Contatos

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

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

Solicitação

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

Resposta
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization></Organization>
        <Name>Jack Slater</Name>
        <Email>test@dynadot.com</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc></FaxCc>
        <FaxNum></FaxNum>
        <Address1>1 Free Way</Address1>
        <Address2></Address2>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
 

Parâmetro de Obtenção de Contato

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

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

Solicitação

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

Resposta
<GetContactResponse>
 <GetContactHeader>
  <ResponseCode>0</ResponseCode>
  <Status>success</Status>
 </GetContactHeader>
 <GetContactContent>
  <Contact>
   <ContactId>12345</ContactId>
   <Organization>org</Organization>
   <Name>name</Name>
   <Email>example@example.com</Email>
   <PhoneCc>0</PhoneCc>
   <PhoneNum>phone number</PhoneNum>
   <FaxCc>example faxcc</FaxCc>
   <FaxNum>example faxnum</FaxNum>
   <Address1>address1</Address1>
   <Address2>address2</Address2>
   <City>city</City>
   <State>state</State>
   <ZipCode>zipcode</ZipCode>
   <Country>country</Country>
  </Contact>
 </GetContactContent></GetContactResponse>
 

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

Solicitação

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

Resposta

<AddNsResponse><AddNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></AddNsHeader><AddNsContent><Server><Host>ns1.mydomain.com</Host><ServerId>0</ServerId></Server></AddNsContent></AddNsResponse>

 

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

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=register_ns&host=domain1.com&ip=192.168.1.1

Resposta

<RegisterNsResponse><RegisterNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></RegisterNsHeader><RegisterNsContent><Server><Host>domain1.com</Host><ServerId>0</ServerId></Server></RegisterNsContent></RegisterNsResponse>

 

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

Solicitação

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

Resposta

<SetNsIpResponse><SetNsIpHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetNsIpHeader></SetNsIpResponse>

 

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

Solicitação

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

Resposta

<DeleteNsResponse><DeleteNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></DeleteNsHeader></DeleteNsResponse>

 

Comando de Listagem de Servidores

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

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

Solicitação

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

Resposta
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
          <ServerIp></ServerIp>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1,,,,,,,,,</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
 

Comando de Informações da Conta

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

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

Solicitação

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

Resposta
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>slater</Username>
      <ForumName>slaterinforum</ForumName>
      <Contact>
        <Organization></Organization>
        <Name>Jack Slater</Name>
        <Email>bishop@dynadot.local</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <Address1>1 Free Way</Address1>
        <Address2></Address2>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</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>
 

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

Solicitação

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

<SetDefaultWhoisResponse><SetDefaultWhoisHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultWhoisHeader></SetDefaultWhoisResponse>

 

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

Solicitação

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

Resposta

<SetDefaultNsResponse><SetDefaultNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultNsHeader><SetDefaultNsContent><Servers><Server><Servername>ns1.hosts.com</Servername><ServerId>1</ServerId></Server><Server><Servername>ns2.hosts.com</Servername><ServerId>2</ServerId></Server></Servers></SetDefaultNsContent></SetDefaultNsResponse>

 

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

Solicitação

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

Resposta

<SetDefaultParkingResponse><SetDefaultParkingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultParkingHeader></SetDefaultParkingResponse>

 

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_urlThe URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
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

Solicitação

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

Resposta

<SetDefaultForwardingResponse><SetDefaultForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultForwardingHeader></SetDefaultForwardingResponse>

 

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_urlThe URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
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

Solicitação

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

<SetDefaultStealthResponse><SetDefaultStealthHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultStealthHeader></SetDefaultStealthResponse>

 

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

Solicitação

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

Resposta

<SetDefaultHostingResponse><SetDefaultHostingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultHostingHeader></SetDefaultHostingResponse>

 

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:

( This command is outdate and not recommended, please use Set Default DNS2 Command instead )

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 - subdomain20 (opcional)Registros de subdomínios
sub_record_type0 - sub_record_type20 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record20 (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

Solicitação

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

<SetDefaultDnsResponse><SetDefaultDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultDnsHeader></SetDefaultDnsResponse>

 

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_recordx19Mx distance, forward type, stealth forward title or email alias, necessary when main_record is "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
subdomain0 - subdomain49 (opcional)Registros de subdomínios
sub_record_type0 - sub_record_type49 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record49 (opcional)Endereço IP do subdomínio ou host de destino
sub_recordx0 - subdo_recordx49Mx distance, forward type, stealth forward title or email alias, necessary when sub_record_type is "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
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

Solicitação

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

<SetDefaultDnsResponse><SetDefaultDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultDnsHeader></SetDefaultDnsResponse>

 

Comando de Definição de Hospedagem Gratuita Padrão

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

Parâmetro de Solicitação de Definição de Hospedagem Gratuita Padrão
Explicação
style (opcional)O estilo da página gratuita
titleO título da página gratuita
bodyA parte principal da página. HTML é permitido, mas as seguintes tags não devem ser incluídas: <html>,<title>, <body>, <meta>, <script>; note que qualquer HTML inserido no corpo não será validado
Tag do resultado em XML
Explicação
<SetDefaultFreeHostResponse></SetDefaultFreeHostResponse>Marcador da resposta de definição de hospedagem gratuita padrão. É o nó raiz do documento de resposta XML
<SetDefaultFreeHostHeader></SetDefaultFreeHostHeader>Cabeçalho de definição de hospedagem gratuita 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"

Exemplo de Definição de Hospedagem Padrão Gratuita

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_free_hosting&title=Obama's shop&body=<div>this is obama's shop</div>

Resposta

<SetDefaultFreeHostResponse><SetDefaultFreeHostHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultFreeHostHeader></SetDefaultFreeHostResponse>

 

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

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&exist_email0=peter@dynadot.com

Resposta

<SetDefaultEmailForwardingResponse><SetDefaultEmailForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingResponse>

 

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 deseja excluir. Pode ser "forward", "stealth", "email_forwarding", "free_hosting", "dns" 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

Solicitação

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

Resposta

<SetClearDefaultSettingResponse><SetClearDefaultSettingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetClearDefaultSettingHeader></SetClearDefaultSettingResponse>

 

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

Solicitação

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

Resposta

<SetDefaultRenewOptionResponse><SetDefaultRenewOptionHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultRenewOptionHeader></SetDefaultRenewOptionResponse>

 

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

Solicitação

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

Resposta

<FolderCreateResponse><FolderCreateHeader><SuccessCode>0</SuccessCode><Status>success</Status></FolderCreateHeader><FolderCreateContent><FolderName>new</FolderName><FolderId>2</FolderId></FolderCreateContent></FolderCreateResponse>

 

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_idThe ID of folders you want to delete, make sure that they separated by commas
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

Solicitação

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

Resposta

<DeleteFolderRespofoldere><DeleteFolderHeader><SuccessCode>0</SuccessCode><Status>success</Status></DeleteFolderHeader></DeleteFolderRespofoldere>

 

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

Solicitação

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

<SetFolderWhoisResponse><SetFolderWhoisHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderWhoisHeader></SetFolderWhoisResponse>

 

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

Solicitação

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

<SetFolderNsResponse><SetFolderNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderNsHeader><SetFolderNsContent><Servers><Server><ServerName>ns1.hosts.com</ServerName><ServerId>0</ServerId></Server><Server><ServerName>ns2.host.com</ServerName><ServerId>1</ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server></Servers></SetFolderNsContent></SetFolderNsResponse>

 

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

Solicitação

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

Resposta

<SetFolderParkingResponse><SetFolderParkingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderParkingHeader></SetFolderParkingResponse>

 

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_urlThe URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
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

Solicitação

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

<SetFolderForwardingResponse><SetFolderForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderForwardingHeader></SetFolderForwardingResponse>

 

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_urlThe URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
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

Solicitação

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

<SetFolderStealthResponse><SetFolderStealthHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderStealthHeader></SetFolderStealthResponse>

 

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

Solicitação

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

Resposta

<SetFolderHostingResponse><SetFolderHostingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderHostingHeader></SetFolderHostingResponse>

 

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:

( This command is outdate and not recommended, please use Set Folder DNS2 Command instead )

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 - subdomain20 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type20 (opcional)Tipo de registros de subdomínio
sub_record0 - sub_record20 (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

Solicitação

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

<SetDnsResponse><SetDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDnsHeader></SetDnsResponse>

 

Definir comando da pasta DNS2

If calling set folder DNS2 command, the following parameters should be included:

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_type19Main record type, should be "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique o registro DNS do seu domínio
main_recordx0 - main_recordx19Mx distance, forward type, stealth forward title or email alias, necessary when main_record_type is "forward","mx","stealth","email"
subdomain0 - subdomain49 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type49 (opcional)Subdomain records type, should be "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record49 (opcional)Endereço IP ou host alvo
sub_recordx0 - sub_recordx49 (opcional)Mx distance, forward type, stealth forward title or email alias, necessary when sub_record_type is "forward","mx","stealth","email"
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

Solicitação

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

<SetDnsResponse><SetDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDnsHeader></SetDnsResponse>

 

Definição de Pasta de Hospedagem Gratuita

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

Parâmetro de Solicitação de Definição de Pasta de Hospedagem Gratuita
Explicação
folder_idID da pasta que você deseja definir
enable (opcional)Se quiser aplicar esta configuração de hospedagem gratuita a 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 hospedagem gratuita para todos os domínios desta pasta, você pode usar este parâmetro com "yes"
style (opcional)O estilo da página gratuita
titleO título da página gratuita
bodyA parte principal da página. HTML é permitido, mas as seguintes tags não devem ser incluídas: <html>,<title>, <body>, <meta>, <script>; note que qualquer HTML inserido no corpo não será validado
Tag do resultado em XML
Explicação
<SetFolderFreeHostingResponse></SetFolderFreeHostingResponse>Marcador da resposta de definição de pasta de hospedagem gratuita. É o nó raiz do documento XML de resposta
<SetFolderFreeHostingHeader></SetFolderFreeHostingHeader>Cabeçalho de definição da pasta de hospedagem gratuita
<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 Gratuita de Pasta

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_free_hosting&folder_id=0&title=obama's shop&body=Welcome to obama's shop&enable=yes&sync=yes

Resposta

<SetFolderFreeHostResponse><SetFolderFreeHostHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderFreeHostHeader></SetFolderFreeHostResponse>

 

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

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&exist_email0=peter@dynadot.com

Resposta

<SetFolderEmailForwardingResponse><SetFolderEmailForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderEmailForwardingHeader></SetFolderEmailForwardingResponse>

 

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 deseja excluir. Pode ser "forward", "stealth", "email_forwarding", "free_hosting", "dns" 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

Solicitação

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

Resposta

<SetClearFolderSettingResponse><SetClearFolderSettingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetClearFolderSettingHeader></SetClearFolderSettingResponse>

 

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

Solicitação

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

Resposta

<SetFolderNameResponse><SetFolderNameHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderNameHeader></SetFolderNameResponse>

 

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 renovar que você deseja definir para a pasta; pode ser "donot" (não), "auto" (automático) ou "reset" (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

Solicitação

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

Resposta

<Response><ResponseHeader><ResponseCode>0</ResponseCode></ResponseHeader></Response>

 

Comando de Listagem de Pastas

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

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

Solicitação

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

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

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

Solicitação

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

Resposta
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
 

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

Solicitação

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

Resposta
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
 

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

Solicitação

https://api.dynadot.com/api3.xml?key=mykey&command=backorder_request_list&month=1&day=31&year=2014

Resposta
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <ResponseCode>0</ResponseCode>
    <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>
Solicitação (formato csv)

http://api.dynadot.com/api3.html?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Resposta

ok,
success,
Domain,CutoffTime,BackorderRequestStatus
domain.com,1431661200000,Active
domain2.com,1431661200000,Success
domain3.com,1431661200000,Success
.
.
.

 

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

Solicitação (formato XML)

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

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

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

 

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

Chamar o comando de obtenção dos detalhes de leilão retornará os detalhes do leilão especificado. Esse comando só está disponível no formato XML. Ao chamar o comando de registo, 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 e o IDN (Nome de Domínio Internacionalizado) devem usar um 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
<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 progresso e '1' para Encerrado pelo administrador, '2' para Encerrado por tempo limite, '3' para Problema
<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)

Exemplo de Obtenção de Detalhes de Leilão

Solicitação

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Resposta
<GetAuctionDetailsResponse>
 <GetAuctionDetailsHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </GetAuctionDetailsHeader>
 <GetAuctionDetailsContent>
   <AuctionStatusId>0</AuctionStatusId>
   <AuctionStatus>In Progress</AuctionStatus>
   <UserIsHighBid>No</UserIsHighBid>
   <YourCurrentBid>-1</YourCurrentBid>
   <YourProxyBid>-1</YourProxyBid>
   <Auction>
     <AuctionId>0</AuctionId>
     <Domain>domain0.com</Domain>
     <BidPrice>6.35</BidPrice>
     <BidPriceCurrency>CNY</BidPriceCurrency>
     <Bids>0</Bids>
     <EndTime>2017/09/03 17:12 UTC</EndTime>
     <EndTimestamp>1504458737058</EndTimestamp>
   </Auction>
 </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
 

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

Solicitação (formato XML)

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

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

 

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 domínio

Solicitação (formato XML)

https://api.dynadot.com/api3.xml?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Resposta
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>domain-exp143.ooo</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>domain-exp144.vc</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>
Solicitação (formato csv)

http://api.dynadot.com/api3.html?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Resposta

ok,
success,
AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid
2,domain.com,4,Closed by Timeout,89.99,USD,1,won,89.99,200
3,domain.com,4,Closed by Timeout,28.99,USD,1,won,28.99,300
.
.
.

 

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

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

Solicitação (formato XML)

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

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

Chamar o comando de obtenção de detalhes dos leilões de domínios pendentes retorna os detalhes de um leilão específico. Este comando está disponível apenas em formato XML. 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 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

Solicitação

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

Resposta
<GetBackorderAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>IN_PROGRESS</AuctionStatus>
      <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>
      <Revenue>114</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>-1</Links>
      <Age>1</Age>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent></GetBackorderAuctionDetailsResponse>
 

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

Solicitação (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
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Solicitação (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

ok,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

Exemplo de Obtenção de Leilões Encerrados

Solicitação (formato XML)

https://api.dynadot.com/api3.xml?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Resposta
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>domain-exp143.ooo</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>domain-exp144.vc</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Solicitação (formato csv)

http://api.dynadot.com/api3.html?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Resposta

ok,
success,
AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid
2,domain.com,4,Closed by Timeout,89.99,USD,1,won,89.99,200
3,domain.com,4,Closed by Timeout,28.99,USD,1,won,28.99,300
.
.
.

 

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

Solicitação

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

Resposta
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Solicitação (formato csv)

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

Resposta

ok,yes