Domínios

Lista de Comandos da API de Domínio

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

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

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

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

As solicitações devem ser enviadas por https (soquete seguro) para segurança. A solicitação deve ter os seguintes dois parâmetros, uma 'Chave' e um 'Comando'. Os comandos podem ser clicados para ver os parâmetros associados a eles.

Você receberá contagens de threads diferentes com base no nível de preço da sua conta:

Nível de preço	Conta
Regular	1 thread
Volume	5 threads
Super volume	25 threads
Volume premium	25 threads

Parâmetro de solicitaçãoExplicação

Parâmetro de solicitação
Explicação

KeySua chave de acesso à API está disponível em seu painel de controle da conta Dynadot no menu lateral 'Ferramentas' -> 'API'.

Command

Domain:

, , , , , ,

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

, , , ,

,

contact:

, , , , , ,

, ,

Nameserver:

, , , , , , ,

Account:

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

Folder:

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

Aftermarket:

, ,

, , , ,

, , , , , , , ,

Other:

, , , , , ,

XMLO texto fornecido deve estar relacionado à indústria de domínio profissional.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Comando de Pesquisa

Support multi-thread

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

Parâmetro de Solicitação de PesquisaExplicação

Parâmetro de Solicitação de Pesquisa
Explicação

domain0 - domain99O nome de domínio que você está procurando, conta comum pode especificar 1 domínio por comando, contas de Massa e super massa podem especificar até 100 domínios

language0 - language99 (opcional)O marcador de idioma do domínio respectivo, apenas para IDNs

show_price (opcional)Se quiser mostrar o preço na moeda da sua conta, defina como "1".

currency (opcional)Você pode decidir o tipo de moeda e este parâmetro suportado são "USD","CNY", "GBP","EUR","INR","CAD" e outros. Se você pular este parâmetro, nós usaremos a moeda padrão da sua conta

Tag do resultado em XMLExplicação

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

Search Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Registro

Support multi-thread

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 RegistroExplicação

Parâmetro de Solicitação de Registro
Explicação

domainO nome de domínio que você deseja registrar, apenas 1 domínio pode ser registrado por solicitação

language (opcional)O marcador de idioma do domínio solicitado. Necessário apenas quando o domínio é um IDN

durationPor quanto tempo registrar o domínio.

registrant_contact (opcional)O contato do registrante que você deseja usar no domínio

admin_contact (opcional)O contato de administração que deseja usar no domínio

technical_contact (opcional)O contato técnico que deseja usar no domínio

billing_contact (opcional)O contato de cobrança que você deseja usar no domínio

option0 (se necessário)
O nome do registrante de .AT, .BE,

option1 (se necessário)A organização registrante .AT, .BE, (opcional)
Para .AT, você pode especificar option0, option1, ou ambos

premium (opcional)Se deseja registrar um domínio premium, defina-o como "1" (opcional)

coupon (opcional)O código de cupom que você quer aplicar a este comando

Tag do resultado em XMLExplicação

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

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Exclusão

Support multi-thread

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

Parâmetro da Solicitação de ExclusãoExplicação

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 XMLExplicaçã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

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Renovação

Support multi-thread

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

Parâmetro de Solicitação de RenovaçãoExplicação

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

price_check (opcional)Você pode adicionar este parâmetro para o comando para verificar os detalhes de preço para renovar este domínio. ATENÇÃO: Adicionar este parâmetro ao comando, nosso api não irá renovar o domínio, mas irá apenas apresentar as informações de preço.

coupon (opcional)O código de cupom que você quer aplicar a este comando

no_renew_if_late_renew_fee_needed (opcional)Você pode adicionar esse parâmetro ao comando para evitar a renovação se o domínio precisar pagar taxa de renovação tardia. Se o domínio precisar pagar taxa de renovação tardia para renovação e 'no_renew_if_late_renew_fee_needed = 1' foi passado no comando, o domínio não será renovado.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<RenewResponse></RenewResponse>Marcador da resposta de renovação. É o nó raiz do documento de resposta XML

<RenewHeader></RenewHeader>Cabeçalho de renovação

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<PriceInfo></PriceInfo>Informação da etiqueta de preço, só é usada para quando o status do domínio é "price_check_success";

<RenewContent></RenewContent>Marcador de renovação de conteúdo, usado apenas quando o status é "success"

<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"

Renew Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de empurrão

Support multi-thread

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

Parâmetros de Requerimento de PushExplicação

Parâmetros de Requerimento de Push
Explicação

domainO nome de domínio que você quer enviar. Nós também suportamos envios em massa, você pode usar ";" para separar domínios. Exemplo: domínio1.com;domínio2.com

receiver_push_usernameInserir nome de usuário da conta destinatária

unlock_domain_for_push(optional)Defina este parâmetro igual a "1" se o domínio estiver bloqueado, nós o desbloquearemos automaticamente, para que você não tenha que debloquear o domínio manualmente

receiver_email(optional)Empurre o email para a conta do destinatário.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<PushResponse></PushResponse>Tag de resposta de push, é o nó raiz necessário para responder o documento XML

<PushHeader></PushHeader>Cabeçálio de Push

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Push Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Transferência

Support multi-thread

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

Parâmetro do Pedido de TransferênciaExplicação

Parâmetro do Pedido de Transferência
Explicação

domainO nome de domínio que você quer transferir para sua conta Dynadot, apenas 1 domínios podem ser transferidos por pedido.

authO código de autorização para o pedido de transferência.

registrant_contact (opcional)O contato de registrante que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)

admin_contact (opcional)O contato admin que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)

technical_contact (opcional)O contato técnico que você quer usar quando a transferência estiver completa. (Nem todos os tlds suportam esta característica)

billing_contact (opcional)O contato de cobrança que você quer usar quando a transferência estiver completa. N(Nem todos os tlds suportam esta característica)

premium (opcional)Se você quiser transferir um domínio premium, defina-o igual a "1" (opcional)

privacy (opcional)O status de privacidade do domínio que você deseja definir pode ser "on" ou "off". O nível de privacidade padrão da conta será aplicado se a entrada estiver incorreta ou não for fornecida.

name_servers (opcional)A lista de servidores de nomes a serem aplicados ao domínio assim que a transferência estiver completa. Você pode usar "," para separar os servidores de nomes. Exemplo: ns1.domain1.com,ns2.domain2.com

coupon (opcional)O código de cupom que você quer aplicar a este comando

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<TransferResponse></TransferResponse>Resposta de tag de transferência, é o root node do documento de resposta XML

<TransferHeader></TransferHeader>Cabeçalho da transferência

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Transferência

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de registro em massa

Support multi-thread

A chamada do comando de registro em massa criará e processará ordens de registro. Você deve ter saldo suficiente na conta para pagar pelas ordens. Se chamar o comando de registro em massa, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de registro em massaExplicação

Parâmetro de solicitação de registro em massa
Explicação

domain0-domain99O(s) nome(s) de domínio que você deseja registrar, um máximo de 100 domínios pode ser registrado por solicitação

premium (opcional)Se deseja registrar um domínio premium, defina-o como "1" (opcional)

currency (opcional)Você pode decidir o tipo de moeda e os parâmetros suportados são "USD", "CNY", "GBP", "EUR", "INR", "CAD" e assim por diante. Se você perder esse parâmetro, usaremos a moeda padrão da conta

coupon (opcional)O código de cupom que você quer aplicar a este comando

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<BulkRegisterResponse></BulkRegisterResponse>Tag de resposta de registro em massa

<BulkRegisterHeader></BulkRegisterHeader>Tag de cabeçalho de registro em massa

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<BulkRegisterContent></BulkRegisterContent>A etiqueta do registro em massa de conteúdo

<Expiration></Expiration>Data de expiração em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970), usado somente quando o resultado é "success"

<Result></Result>O resultado da ação de registro

<Message></Message>Mensagem de erro de ação de registro, só utilizada quando o resultado é "error"

Exemplo de registro em massa

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Informações de Domínios

Support multi-thread

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

Parâmetro de Solicitação de Informações de DomíniosExplicação

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 XMLExplicação

Tag do resultado em XML
Explicação

<DomainInfoResponse></DomainInfoResponse>Nó raiz do documento de resposta XML

<DomainInfoResponseHeader></DomainInfoResponseHeader>Cabeçalho de resposta

<ResponseCode></ResponseCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<DomainInfoContent></DomainInfoContent>Conteúdo de resposta

<Domain></Domain>Domínio

<Name></Name>Nome do domínio

<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)

<Registration></Registration>Data de registro de Domínio é em tempo Unix (milissegundos após a meia-noite UTC de 1, 1970 de Janeiro)

<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio

<Type></Type>Tipo de servidor de nomes do domínio

<WithAds></WithAds>Se você quiser uma página de estacionamento para o seu domínio

<Whois></Whois>Informações do Whois

<Registrant></Registrant>Informações do registrante

<ContactId></ContactId>ID do contato

<Admin></Admin>Informações administrativas

<Technical></Technical>Informações técnicas

<Billing></Billing>Informações de cobrança

<Locked></Locked>Bloqueado ou não

<Disabled></Disabled>Status habilitado

<UdrpLocked></UdrpLocked>UDRP bloqueado ou não

<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

Domain Information Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Whois

Support multi-thread

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 WhoisExplicação

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 XMLExplicação

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"

Set Whois Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Servidores de Nomes

Support multi-thread

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 NomesExplicação

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 XMLExplicação

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"

Definir Ns Exemplo

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Estacionamento

Support multi-thread

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 EstacionamentoExplicação

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 XMLExplicação

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"

Set Parking Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Redirecionamento

Support multi-thread

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 RedirecionamentoExplicação

Parâmetro de Solicitação de Definição de Redirecionamento
Explicação

domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas

forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.

is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"

Tag do resultado em XMLExplicação

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"

Set Forwarding Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Secretividade

Support multi-thread

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 SecretividadeExplicação

Parâmetro de Solicitação de Definição de Secretividade
Explicação

domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas

stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.

stealth_title (opcional)O título da página

Tag do resultado em XMLExplicação

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"

Set Stealth Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Hospedagem

Support multi-thread

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 HospedagemExplicação

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 XMLExplicação

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"

Set Hosting Example

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

Response (XML format)

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

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

Response (JSON format)

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

Definir comando DNS2

Support multi-thread

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

Por favor, note que a execução do comando SET_DNS2 irá, por padrão, sobrescrever as configurações de DNS atuais. Para alterar esse comportamento e adicionar as novas configurações de DNS em vez de sobrescrevê-las, você pode usar o parâmetro opcional add_dns_to_current_setting.

Parâmetro de definição de solicitação de DNS2Explicação

Parâmetro de definição de solicitação de DNS2
Explicação

domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas

main_record_type0 - main_record_type19 (optional)Tipo de registro principal, deve ser "a", "aaaa", "cname", ""forward", "txt", "mx", "stealth", "email"

main_record0 - main_record19Especifique o registro DNS do seu domínio

main_recordx0 - main_recordx19Distância Mx, tipo de envio(301 como "1", 302 como "2"), título de envio oculto ou alias de e-mail quando o tipo_de_registro_p´rincial é "forward", "mx", "oculto", "e-mail".

subdomain0 - subdomain99 (opcional)Subdomain records (opcional)

sub_record_type0 - sub_record_type99O tipo de subdomínio deve ser "a", "aaaa", "cname", "encaminhamento", "txt", "srv", "mx", "privado", "e-mail"

sub_record0 - sub_record99Endereço IP do subdomínio ou host de destino

sub_recordx0 - sub_recordx99Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias de e-mail quando o registro_principal é "encaminhado" "mx", "privado", "e-mail"

ttl (opcional)Tempo de existência

add_dns_to_current_setting (opcional)Se desejar acrescentar as novas configurações de DNS às configurações de DNS existentes. Defina-o como "1" (opcional)

Tag do resultado em XMLExplicação

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"

Set DNS2 Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando Dnssec definido

Support multi-thread

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

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

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

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

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

Definir Parâmetro de Solicitação DnssecExplicação

Definir Parâmetro de Solicitação Dnssec
Explicação

domain_nameO nome de domínio para o qual você precisa configurar o dnssec

key_tagChaveiro

digest_typeVocê pode escolher um número da lista a seguir para representar o tipo de assinatura digital: SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)

digestPor favor, insira o valor correspondente ao tipo de resumo que você selecionou.

algorithmVocê pode escolher um número da lista a seguir para representar seu algoritmo de assinatura digital: RSA/MD5(1) Diffie-Hellman (2) DSA/SHA-1(3) Elliptic Curve (4) RSA/SHA-1(5) DSA-NSEC3-SHA1(6) RSASHA1-NSEC3-SHA1(7) RSA/SHA-256(8) RSA/SHA-512(10) GOSTR 34.10-2001(12) ECDSA Curve P-256 com SHA-256(13) ECDSA Curve P-384 com SHA-384(14) ED25519(15) ED448(16) Indireto (252) DNS Privado (253) OID Privado (254)

flagsVocê pode escolher um número da lista a seguir para representar seu símbolo de assinatura digital: ZSK (256) KSK (257)

public_keyA chave pública deve estar na codificação base64.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetDnssecResponse></SetDnssecResponse>O nó raiz da resposta

<SetDnssecHeader></SetDnssecHeader>Defina o cabeçalho Dnssec

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Exemplo de configuração do Dnssec

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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-mailsExplicação

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 XMLExplicação

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"

Set Email Forward Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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ínioExplicação

Parâmetro de Solicitação de Definição de Limpeza de Configurações de Domínio
Explicação

domainO nome de domínio que você deseja definir, 100 domínios podem ser definidos por solicitação, certifique-se de que eles estejam separados por vírgulas

serviceO serviço que você deseja limpar pode ser "forward", "stealth", "email_forwarding", "dns", "dnssec", e "nameservers"

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nó raiz do documento de resposta XML

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

Set Clear Domain Setting Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Pasta

Support multi-thread

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 PastaExplicação

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 XMLExplicação

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"

Set Folder Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Nota

Support multi-thread

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 NotaExplicação

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 XMLExplicação

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"

Set Note Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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

Definir parâmetro de solicitação de ID do clienteExplicação

Definir parâmetro de solicitação de ID do cliente
Explicação

domainO domínio que deseja definir , vários domínios são separados por vírgulas ( Max :100 )

customer_idO ID do cliente que você deseja definir para o domínio não pode ser nulo

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetCustomerIdResponse></SetCustomerIdResponse>Nó raiz do documento de resposta XML

<SetCustomerIdHeader></SetCustomerIdHeader>Cabeçalho de resposta

<SetCustomerIdContent></SetCustomerIdContent>Conteúdo de resposta

<SetCustomerIdSuccess></SetCustomerIdSuccess>Conteúdo de resposta de sucesso ao definir o ID do cliente

<SetCustomerIdFailed></SetCustomerIdFailed>Falha na configuração do ID do cliente no conteúdo da resposta

<ResponseCode></ResponseCode>Se a operação for bem sucedida, "0" para sucesso, "-1" para falha, "1" para problema

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de Identificação do Cliente

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

Response (XML format)

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

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

Response (JSON format)

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

Opções de Renovação

Support multi-thread

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çãoExplicação

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 XMLExplicação

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

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Privacidade

Support multi-thread

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 PrivacidadeExplicação

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"

whois_privacy_optionO status de privacidade whois do domínio que você deseja definir pode ser "yes" ou "no".

Tag do resultado em XMLExplicação

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"

Set Privacy Example

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

Response (XML format)

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

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

Response (JSON format)

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

Preços de TLD

Support multi-thread

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

Pedido de Parâmetros de Preços TldExplicação

Pedido de Parâmetros de Preços Tld
Explicação

currency (opcional)A moeda de resultado de retorno, deve ser "usd", "eur", ou "cny", a moeda padrão é a MOeda Padrão Api das definições da conta.

count_per_page (optional)Quantas entidades são exibidas por página

page_index (optional)De quais entidades da página você deseja visualizar?

sort (optional)Por favor, selecione uma das seguintes opções como valor para o parâmetro de ordenação:
* Se você não a selecionar, usaremos a ordenação padrão.
1) RankAsc (Padrão)
2) RankDesc
3) NameAsc
4) NameDesc
5) SalesAsc
6) SalesDesc
7) LaunchDateAsc
8) LaunchDateDesc
9) CountAsc
10) CountDesc
11) RegistryAsc
12) RegistryDesc

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<TldPriceResponse></TldPriceResponse>Nó raiz do documento de resposta XML

<TldPriceResponseHeader></TldPriceResponseHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<TldPriceContent></TldPriceContent>Conteúdo de resposta

<TldContent></TldContent>Informações de Tld

<Tld></Tld>Domínios de Topo

<Usage></Usage>Uso de tld

<Price></Price>Informações de preço deste TLD. Contém subetiquetas: : Unidade de preço : Preço de registro : Preço de renovação : Preço de transferência.

<Privacy></Privacy>Se este tld suporta privacidade

<GracePeriod></GracePeriod>Informações do período de carência deste tld. Contém subetiquetas: : Unidade de informações do período de carência : Período de carência para renovação : Período de carência para exclusão

<IDN></IDN>Se este tld suporta Nomes de Domínios Internacionalizados

<Restrictions></Restrictions>Nome do domínio

TLD Prices Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Listagem dos Domínios

Support multi-thread

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

Parâmetro de Solicitação de Listagem de DomíniosExplicação

Parâmetro de Solicitação de Listagem de Domínios
Explicação

customer_id (opcional)Filtrar dados por ID de cliente ( apenas revendedores podem usar esse parâmetro )

count_per_page (optional)Quantas entidades são exibidas por página

page_index (optional)De quais entidades da página você deseja visualizar?

sort (optional)Por favor, selecione uma das seguintes opções como valor para o parâmetro de classificação:
* Se você não tiver selecionado, iremos utilizar a classificação padrão.
1) CountAsc (Padrão)
2) CountDesc
3) NameAsc
4) NameDesc

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<ListDomainInfoResponse></ListDomainInfoResponse>Nó raiz do documento de resposta XML

<ListDomainInfoHeader></ListDomainInfoHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<ListDomainInfoContent></ListDomainInfoContent>Conteúdo de resposta

<DomainInfoList></DomainInfoList>Lista de informações dos domínios

<DomainInfo></DomainInfo>Informações do domínio

<Domain></Domain>Domínio

<Name></Name>Nome do domínio

<Expiration></Expiration>Data de expiração do domínio em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)

<Registration></Registration>Data de registro de Domínio é em tempo Unix (milissegundos após a meia-noite UTC de 1, 1970 de Janeiro)

<NameServerSettings></NameServerSettings>Configurações de servidores de nomes

<Type></Type>Tipo de configuração de servidor de nomes

<WithAds></WithAds>Com anúncios ou não

<Whois></Whois>Informações do Whois

<Registrant></Registrant>Informações do registrante

<ContactId></ContactId>ID do contato

<Admin></Admin>Informações administrativas

<Technical></Technical>Informações técnicas

<Billing></Billing>Informações de cobrança

<Locked></Locked>Bloqueado ou não

<Disabled></Disabled>Status habilitado

<Hold></Hold>Retido

<Privacy></Privacy>Status de privacidade

<isForSale></isForSale>Status da venda

<RenewOption></RenewOption>Opção de renovação

<Note></Note>Notas

<Folder></Folder>Informações da pasta

<FolderId></FolderId>ID da Pasta

<FolderName></FolderName>Nome da pasta

Exemplo de Listagem de Domínios

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de bloqueio de domínio

Support multi-thread

Se for chamado o comando de bloqueio de domínio, os seguintes parâmetros devem ser incluídos:

Parâmetro de solicitação de bloqueio de domínioExplicação

Parâmetro de solicitação de bloqueio de domínio
Explicação

domainO nome de domínio que você deseja bloquear, somente um domínio 1 pode ser inserido por solicitação

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<LockDomainResponse></LockDomainResponse>O root node do documento XML de respostaXML.

<LockDomainHeader></LockDomainHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Lock Domain Example

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

Response (XML format)

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

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

Response (JSON format)

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

Cancelar Comando de Transferência

Support multi-thread

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

Parâmetro de Cancelamento de Solicitação de TransferênciaExplicação

Parâmetro de Cancelamento de Solicitação de Transferência
Explicação

domainO nome de domínio que você deseja cancelar a transferência, somente um domínio 1 pode ser inserido por solicitação

order_idO ID do pedido de transferência pode ser obtido de outra API get_transfer_status.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<CancelTransferResponse></CancelTransferResponse>O root node do documento XML de respostaXML.

<CancelTransferHeader></CancelTransferHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Exemplo de cancelamento de transferência

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Status de Transferência

Support multi-thread

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

Obter parâmetro de solicitação de status de transferênciaExplicação

Obter parâmetro de solicitação de status de transferência
Explicação

domainO nome de domínio que você deseja obter o status de transferência, somente 1 domínio pode ser inserido por solicitação

transfer_typeO tipo de transferência para o qual você deseja obter o status da transferência (transferência de entrada ou transferência de saída)

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetTransferStatusResponse></GetTransferStatusResponse>O root node do documento XML de respostaXML.

<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetTransferStatusContent></GetTransferStatusContent>Conteúdo de resposta

<TransferList></TransferList>Lista de transferência

<Transfer></Transfer>Transferir informações

<OrderId></OrderId>O ID do pedido

<TransferStatus></TransferStatus>O status de transferência do domínio. Se você obteve 'nenhum' ou 'aprovado', pode cancelar a transferência. Se você obteve 'aguardando', significa que a transferência já começou. Se você obteve 'código de autorização necessário', significa que o código de autorização está incorreto, você pode usar outra API SET_TRANSFER_AUTH para reenviar o código de autorização. Há também outros estados, enviaremos um e-mail ou precisará ser verificado por nossos engenheiros.

Get Transfer Status Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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

Definir parâmetro de solicitação de código de autorização de transferênciaExplicação

Definir parâmetro de solicitação de código de autorização de transferência
Explicação

domainO nome de domínio para o qual você atualiza a autorização de transferência só pode ser inserido um domínio 1 por solicitação

auth_codeO código de autenticação que você deseja reenviar

order_idO ID do pedido de transferência pode ser obtido de outra API get_transfer_status.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetTransferStatusResponse></GetTransferStatusResponse>O root node do documento XML de respostaXML.

<GetTransferStatusHeader></GetTransferStatusHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Set Transfer Auth Code Example

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

Response (XML format)

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

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

Response (JSON format)

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

Autorizar Comando de Transferência de Saída

Support multi-thread

Parâmetro de solicitação de transferência autorizadaExplicação

Parâmetro de solicitação de transferência autorizada
Explicação

domainApenas 1 domínio pode ser inserido por solicitação para autorizar transferência para longe

order_idO ID do pedido Dynadot do domínio que você deseja transferir para longe

authorizePara autorizar a transferência, defina o valor como "aprovar". Para negar a transferência, defina o valor como "negar".

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>O root node do documento XML de respostaXML.

<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<Result></Result>O resultado da transferência autorizada

Autorizar a transferência de exemplo

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

Response (XML format)

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

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

Response (JSON format)

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

Comando Para o Código de Transferência Auth

Support multi-thread

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

Receba um Parâmetro para o Pedido de Auth CodeExplicação

Receba um Parâmetro para o Pedido de Auth Code
Explicação

domainO nome de domínio para o qual você quer um código de autenticação de transferência, apenas domínios 1 podem ser inseridos por pedido.

new_code (optional)Gerar novo auth code de transferência.

unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Se você quer desbloquear domínios para transferência, defina igual a "1". Se o pedido for processado com sucesso, o domínio será desbloqueado.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>O root node do documento XML de respostaXML.

<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<AuthCode></AuthCode>O Auth Code é usado para começar uma transferência de domínio.

Exemplo de Recebimento de Auth Code de Transferência

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de solicitação de empurrão de domínio

Support multi-thread

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

Obter parâmetro de solicitação de push de domínioExplicação

Obter parâmetro de solicitação de push de domínio
Explicação

N/ANenhum parâmetro extra é necessário

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetDomainPushRequestResponse></GetDomainPushRequestResponse>O nó raiz da resposta

<GetDomainPushRequestHeader></GetDomainPushRequestHeader>Obter cabeçalho de solicitação de push de domínios

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

<GetDomainPushRequestContent></GetDomainPushRequestContent>conteúdo de resposta

<PushDomain></PushDomain>Push de domínio

<PushDomainName></PushDomainName>Empurrar Nome de Domínio

Get Domain Push Request Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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

Definir parâmetro de solicitação de envio de domínioExplicação

Definir parâmetro de solicitação de envio de domínio
Explicação

domainsO nome de domínio do pedido a ser processado

actionA ação do pedido a ser processado. Você pode escolher 'aceitar' ou 'recusar'.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetDomainPushRequestResponse></SetDomainPushRequestResponse>O nó raiz da resposta

<SetDomainPushRequestHeader></SetDomainPushRequestHeader>Definir cabeçalho de solicitação de push de domínio

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Set Domain Push Request Example

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

Response (XML format)

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

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

Response (JSON format)

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

Criar comando de Auditoria CN

Support multi-thread

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

Criar parâmetro de solicitação de auditoria CNExplicação

Criar parâmetro de solicitação de auditoria CN
Explicação

contact_idO ID do registro do contato para o qual você deseja iniciar a auditoria, apenas 1 IDs de contato podem ser inseridos por solicitação.

contact_typeTipo de contato, pode ser "Individual" ou "Empresa"

individual_id_typeTipo de ID de pessoa natural, valores esperados (descrição do valor) são:
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)

individual_license_idNúmero de licença do documento de identificação da pessoa natural

individual_urlDocumento de identificação de licença de pessoa física. O URL do arquivo no servidor. Somente arquivos jpg, gif, png, jpeg são permitidos

enterprise_id_type (Mandatory when contact type is "Enterprise")Tipo de ID da empresa, os valores esperados (descrição do valor) são:
ORG (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)

enterprise_license_id (Mandatory when contact type is "Enterprise")Número da licença do documento da empresa

enterprise_url (Mandatory when contact type is "Enterprise")Documento da licença da empresa. URL do arquivo no servidor. Apenas JPG, GIF, PNG, JPEG são permitidos

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<CreateCnAuditResponse></CreateCnAuditResponse>Nó raiz do documento de resposta XML

<CreateCnAuditHeader></CreateCnAuditHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

Criar Exemplo de Auditoria de Domínio

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

Response (XML format)

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

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

Response (JSON format)

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

Comando Obter Status de Auditoria Cn

Support multi-thread

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

Obter parâmetros de solicitação de status de auditoria CnExplicação

Obter parâmetros de solicitação de status de auditoria Cn
Explicação

contact_idO ID do registro de contato que você deseja obter o status de auditoria, apenas 1 contactId pode ser inserido por solicitação

gtldSe você consultar o resultado da auditoria do cnnic-gtld, defina este parâmetro como 1

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetCnAuditStatusResponse></GetCnAuditStatusResponse>O root node do documento XML de respostaXML.

<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<CnAuditStatus></CnAuditStatus>O status de auditoria do registro de auditoria da CNNIC. Você pode obter 'processando' ou 'aguardando a CNNIC' ou 'falhou'. Se falhar, enviaremos um e-mail para você.

<FailedReason></FailedReason>Se a auditoria não for aprovada, o motivo do falha será exibido.

Obter Exemplo de Status de Auditoria Cn

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Criação de Contatos

Support multi-thread

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 ContatoExplicação

Parâmetro de Solicitação de Criação de Contato
Explicação

organization (opcional)Informações da organização

nameNome

emailE-mail

phonenumNúmero de telefone

phoneccCódigo de telefone do país

faxnum (opcional)Número de fax

faxcc (opcional)Código de fax do país

address1Endereço 1

address2 (opcional)Endereço 2

cityCidade

state (opcional)Estado

zipCEP

countryPaís

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<CreateContactResponse></CreateContactResponse>Nó raiz do documento de resposta XML

<CreateContactHeader></CreateContactHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<CreateContactContent></CreateContactContent>Novo ID de contato, só usado quando o status é "success".

Create Contact Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Edição de Contato

Support multi-thread

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 ContatoExplicação

Parâmetro de Solicitação de Edição de Contato
Explicação

contact_idID do contato que deseja editar

organization (opcional)Informações da organização

nameNome

emailE-mail

phonenumNúmero de telefone

phoneccCódigo de telefone do país

faxnum (opcional)Número de fax

faxcc (opcional)Código de fax do país

address1Endereço 1

address2 (opcional)Endereço 2

cityCidade

stateEstado

zipCEP

countryPaís

Tag do resultado em XMLExplicação

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 Contato

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>

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

Response (JSON format)

{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response Setor de domínio profissional.

ok,

success,
,

Comando de Exclusão de Contatos

Support multi-thread

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 ContatosExplicação

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 XMLExplicação

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

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Listagem dos Contatos

Support multi-thread

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

Parâmetro de Solicitação de Listagem de ContatosExplicação

Parâmetro de Solicitação de Listagem de Contatos
Explicação

N/ANenhum parâmetro extra é necessário

Tag do resultado em XMLExplicação

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

Contact List Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>test street</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>

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

Response (JSON format)

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

Parâmetro de Obtenção de Contato

Support multi-thread

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

Parâmetro de Solicitação de Obtenção de ContatoExplicação

Parâmetro de Solicitação de Obtenção de Contato
Explicação

contact_idid do contato

Tag do resultado em XMLExplicação

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

Get Contact Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>

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

Response (JSON format)

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

Definir Comando de Configuração de Contato da UE

Support multi-thread

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

Definir parâmetro de solicitação de configuração do contato da UEExplicação

Definir parâmetro de solicitação de configuração do contato da UE
Explicação

contact_idID do contato que deseja editar

country_of_citizenshipDeve ser um estado membro da UE, Os códigos de país dos estados membros incluem: AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LI, LT, LU, MT, NL, NO, PL, PT, RO, SK, SI, ES, SE

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetContactEUSettingResponse></SetContactEUSettingResponse>Nó raiz do documento de resposta XML

<SetContactEUSettingHeader></SetContactEUSettingHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<SetContactEUSettingContent></SetContactEUSettingContent>Conteúdo de resposta

<ContactId></ContactId>ID do contato

Set Contact EU Setting Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>

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

Response (JSON format)

{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Comando de configuração de LV de contato definido

Support multi-thread

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

Definir parâmetro de solicitação de configuração de contato LVExplicação

Definir parâmetro de solicitação de configuração de contato LV
Explicação

contact_idID do contato que deseja editar

registration_number- Para indivíduos, por favor, digite o número de identificação letão.
- Para empresas e outras entidades legais, por favor, digite o número de registro emitido pelo Registro de Empresas da Letônia.

vat_number (opcional)Número de IVA para entidades legais estrangeiras registradas em países da União Europeia (isso inclui também empresas letãs)

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetContactLvSettingResponse></SetContactLvSettingResponse>Nó raiz do documento de resposta XML

<SetContactLvSettingHeader></SetContactLvSettingHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<SetContactLvSettingContent></SetContactLvSettingContent>Conteúdo de resposta

<ContactId></ContactId>ID do contato

Definir exemplo de configuração de Nível de Contato

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (JSON format)

{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Set Contact LV Setting Example

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response Setor de domínio profissional.

ok,success,0

Receber Comando de Nome de Servidor

Support multi-thread

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

Receber Parâmetro de Pedido de Nome de ServidorExplicação

Receber Parâmetro de Pedido de Nome de Servidor
Explicação

domainO domínio cujas informações de servidor de nome se deseja obter, apenas as informações de servidor de nomes de 1 domínio podem ser recebidas por solicitação.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetNsResponse></GetNsResponse>Nó raiz do documento de resposta XML

<GetNsHeader></GetNsHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<NsContent></NsContent>Conteúdo de resposta

<Host></Host>Nome de Hospedagem do servidor

<NsName></NsName>Nome do servidor

Obter Exemplo Ns

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>

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

Response (JSON format)

{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}

Comando de Adição de Servidor de Nomes

Support multi-thread

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 NomesExplicação

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 XMLExplicação

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 Ns

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>

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

Response (JSON format)

{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}

Comando de Registro de Servidor de Nomes

Support multi-thread

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 NomesExplicação

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 XMLExplicação

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

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

Response (XML format)

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

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

Response (JSON format)

{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}

Comando de Definição de IP de Servidor de Nomes

Support multi-thread

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 NomesExplicação

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 XMLExplicação

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"

Set Name Server IP Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response (JSON format)

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

Comando de Exclusão de Servidor de Nomes

Support multi-thread

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 NomesExplicação

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 XMLExplicação

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"

Proibir todos asterisco, marcas, símbolos, etiqueta HTML, ser traduzido.

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Apagamento de Nome de Servidor pelo Domínio

Support multi-thread

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

Parâmetro de Apagamento de Nome de Domínio Por Pedido de DomínioExplicação

Parâmetro de Apagamento de Nome de Domínio Por Pedido de Domínio
Explicação

server_domainNome do nome servidor name. ex.: ns1.testnameserver.com

Tag do resultado em XMLExplicação

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"

Delete Name Server By Domain Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Listagem de Servidores

Support multi-thread

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

Parâmetro de Solicitação de Listagem de ServidoresExplicação

Parâmetro de Solicitação de Listagem de Servidores
Explicação

N/ANenhum parâmetro extra é necessário

Tag do resultado em XMLExplicação

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

<ServerId></ServerId>ID do servidor

<ServerName></ServerName>Name do servidor

<ServerIp></ServerIp>IP do servidor

Server List Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
          <ServerIp>1.1.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>

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

Response (JSON format)

{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIps": [
          {
            "Ip": "192.168.1.1"
          },
          {
            "Ip": "1.1.1.1"
          }
        ]
      }
    ]
  }
}

Comando para obter as configurações do servidor DNS de domínio

Support multi-thread

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

Obter parâmetro de solicitação de configurações de servidor de nomes de domínioExplicação

Obter parâmetro de solicitação de configurações de servidor de nomes de domínio
Explicação

domainO domínio cuja configuração do servidor de nomes você deseja obter pode ser puxado por solicitação somente para a configuração do servidor de nomes do domínio 1.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetDnsResponse></GetDnsResponse>Nó raiz do documento de resposta XML

<GetDnsHeader></GetDnsHeader>Cabeçalho de resposta

<ResponseCode></ResponseCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetDnsContent></GetDnsContent>Conteúdo de resposta

<NameServerSettings></NameServerSettings>Configurações do servidor de nomes do domínio

<Type></Type>Tipo de servidor de nomes do domínio

Get Domain Nameserver Settings Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>

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

Response (JSON format)

{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}

Comando de Informações da Conta

Support multi-thread

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

Parâmetro de Solicitação de Informações da ContaExplicação

Parâmetro de Solicitação de Informações da Conta
Explicação

N/ANenhum parâmetro extra é necessário

Tag do resultado em XMLExplicação

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

Account Information Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <AvatarUrl>test avatar url</AvatarUrl>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>

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

Response (JSON format)

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

Comando de Obtenção do Saldo da Conta

Support multi-thread

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

Obter parâmetro de solicitação de saldo da contaExplicação

Obter parâmetro de solicitação de saldo da conta
Explicação

N/ANenhum parâmetro extra é necessário

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetAccountBalanceResponse></GetAccountBalanceResponse>O root node do documento XML de respostaXML.

<GetAccountBalanceHeader></GetAccountBalanceHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetAccountBalanceContent></GetAccountBalanceContent>Conteúdo de resposta

<Balance></Balance>Saldo da Conta

Get Account Balance Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>

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

Response (JSON format)

{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}

Definição Padrão de Whois

Support multi-thread

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ãoExplicação

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 XMLExplicação

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"

Set Default Whois Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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ãoExplicação

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 XMLExplicação

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

Definir Exemplo de Ns Padrão

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultNsResponse>
  <SetDefaultNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultNsHeader>
  <SetDefaultNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetDefaultNsContent>
</SetDefaultNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response (JSON format)

{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}

Comando de Definição de Estacionamento Padrão

Support multi-thread

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ãoExplicação

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 XMLExplicação

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"

Set Default Parking Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Redirecionamento Padrão

Support multi-thread

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ãoExplicação

Parâmetro de Solicitação de Definição de Redirecionamento Padrão
Explicação

forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.

is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"

Tag do resultado em XMLExplicação

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"

Set Default Forwarding Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Secretividade Padrão

Support multi-thread

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ãoExplicação

Parâmetro de Solicitação de Definição de Secretividade Padrão
Explicação

stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.

stealth_title (opcional)O título da página

Tag do resultado em XMLExplicação

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"

Set Default Stealth Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Hospedagem Padrão

Support multi-thread

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ãoExplicação

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 XMLExplicação

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"

Set Default Hosting Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de DNS Padrão

Support multi-thread

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

Este comando está desatualizado e não é recomendado, por favor use o comando Set Default DNS2 em vez disso.

Parâmetro de Solicitação de Definição de DNS PadrãoExplicação

Parâmetro de Solicitação de Definição de DNS Padrão
Explicação

main_record_typeTipo principal de registro

main_recordEspecifica um registro DNS para o seu domínio

main_txt (opcional)Especifica um registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.

main_record2Registro principal 2, usado somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.

subdomain0 - subdomain99 (opcional)Registros de subdomínios

sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio

sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo

mx_host0 - mx_host2 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.

mx_distance0 - mx_distance2 (opcional)Distance0 é de prioridade mais alta

ttl (opcional)Tempo de existência

Tag do resultado em XMLExplicação

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"

Set Default DNS Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)

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

Comando de definição do DNS2 padrão

Support multi-thread

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ãoExplicação

Definir parâmetro de solicitação de DNS2 padrão
Explicação

main_record_type0 - main_record_type19Tipo principal de registro

main_record0 - main_record19Especifique o registro DNS do seu domínio

main_recordx0 - main_recordx19Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias do e-mail, necessário quando o registro_principal é "a", "aaaa", "cname", "encaminhamento", "txt", "mx", "privado", "e-mail"

subdomain0 - subdomain99 (opcional)Registros de subdomínios

sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio

sub_record0 - sub_record99 (opcional)Endereço IP do subdomínio ou host de destino

sub_recordx0 - subdo_recordx99Distância mx, tipo de encaminhamento, encaminhamento privado título ou alias de e-mail, necessário quando o sub_registro for "a", "aaaa", "cname", "encaminhamento", "txt", "srv", "mx", "privado", "e-mail"

ttl (opcional)Tempo de existência

Tag do resultado em XMLExplicação

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"

Set Default DNS2 Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)

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

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

Support multi-thread

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ãoExplicação

Parâmetro de Solicitação de Definição de Redirecionamento de E-mails Padrão
Explicação

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 XMLExplicação

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"

Set Default Email Forward Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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ãoExplicação

Parâmetro de Solicitação de Definição de Limpeza de Configurações Padrão
Explicação

serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"

Tag do resultado em XMLExplicação

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"

Set Clear Default Setting Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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ãoExplicação

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 XMLExplicação

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

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Criação de Pastas

Support multi-thread

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 PastasExplicação

Parâmetro de Solicitação de Criação de Pastas
Explicação

folder_nameNome da pasta que você deseja criar

Tag do resultado em XMLExplicação

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

Create Folder Example

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

Response (XML format)

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

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

Response (JSON format)

{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}

Comando de exclusão de pasta

Support multi-thread

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 pastaExplicação

Parâmetro de solicitação de exclusão de pasta
Explicação

folder_idO ID das pastas que você quiser deletar, assegure-se de que eles estão separados por vírgulas

Tag do resultado em XMLExplicação

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

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1

Response (JSON format)

{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}

Comando de definição de pasta Whois

Support multi-thread

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 WhoisExplicação

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 XMLExplicação

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"

Set Folder Whois Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Pasta de Servidores de Nomes

Support multi-thread

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 NomesExplicação

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 XMLExplicação

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

Definir Pasta Ns Exemplo

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetFolderNsResponse>
  <SetFolderNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNsHeader>
  <SetFolderNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetFolderNsContent>
</SetFolderNsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response (JSON format)

{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}

Comando de Definição de Pasta de Estacionamento

Support multi-thread

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 EstacionamentoExplicação

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 XMLExplicação

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"

Set Folder Parking Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Redirecionamento de Pastas

Support multi-thread

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 PastasExplicação

Parâmetro de Solicitação de Definição de Redirecionamento de Pastas
Explicação

folder_idA ID da pasta que deseja configurar

forward_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.

is_temp (opcional)O status de redirecionamento do seu domínio cujo valor padrão é "temporary", se quiser redirecioná-lo permanentemente, use este parâmetro com "no"

enable (opcional)Se quiser aplicar estas configurações de redirecionamento aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"

sync (opcional)Se quiser sincronizar as configurações de redirecionamento com todos os domínios desta pasta, você pode usar este parâmetro com "yes"

Tag do resultado em XMLExplicação

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"

Set Folder Forwarding Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes

Response (JSON format)

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

Comando de Definição de Secretividade de Pastas

Support multi-thread

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 SecretividadeExplicação

Parâmetro de Solicitação de Definição de Pasta com Secretividade
Explicação

folder_idA ID da pasta que você deseja configurar

stealth_urlO URL para qual você quer que seu domínio seja encaminhado. Note que o parâmetro deve ser codificado para que o pedido de API seja interpretado corretamente.

stealth_title (opcional)O título da página

enable (opcional)Se quiser aplicar estas configurações aos futuros domínios que mover para esta pasta, você pode usar este parâmetro com "yes"

sync (opcional)Se quiser sincronizar as configurações de redirecionamento secreto com todos os domínios desta pasta, você pode usar este parâmetro com "yes"

Tag do resultado em XMLExplicação

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"

Set Folder Stealth Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição de Pasta de Hospedagem

Support multi-thread

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 HospedagemExplicação

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 XMLExplicação

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"

Set Folder Hosting Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response (JSON format)

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

Comando de Definição de Pasta de DNS

Support multi-thread

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

Este comando está desatualizado e não é recomendado, por favor utilize o comando Set Folder DNS2 em vez disso.

Definir Parâmetro de Solicitação de Pasta de DNSExplicação

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

with_ads (opcional)Especifica um registro TXT para o seu domínio. Se seu main_record_type for aaaa e se for especificado um main_record2, você pode definir até 3 main_txts, caso contrário, você pode definir até 4 main_txts.

main_record2Registro principal 2, usado somente quando "main_record_type" for "aaaa". Seu valor deve estar no formato ipv4.

subdomain0 - subdomain99 (opcional)Subdomain records (opcional)

sub_record_type0 - sub_record_type99 (opcional)Tipo de registros de subdomínio

sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo

mx_host0 - mx_host2 (opcional)Especifica a hospedagem de e-mail do seu domínio. distance0 é a prioridade mais alta.

mx_distance0 - mx_distance2 (opcional)Distance0 é de prioridade mais alta

ttl (opcional)Tempo de existência

enable (opcional)Se quiser aplicar estas configurações de DNS aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"

sync (opcional)Se quiser sincronizar as configurações do servidor DNS de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"

Tag do resultado em XMLExplicação

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"

Set Folder DNS Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (XML format)

<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response (JSON format)

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

Definir comando da pasta DNS2

Support multi-thread

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

Parâmetro de definição de solicitação de pasta DNS2Explicação

Parâmetro de definição de solicitação de pasta DNS2
Explicação

folder_idA ID da pasta que você deseja definir

main_record_type0 - main_record_type19Tipo de registro principal, deve ser "a", "aaaa", "cname", ""forward", "txt", "mx", "stealth", "email"

main_record0 - main_record19Especifique o registro DNS do seu domínio

main_recordx0 - main_recordx19Distância mx, tipo de encaminhamento, encaminhamento privado, título ou alias de e-mail quando o registro_principal é "encaminhado" "mx", "privado", "e-mail"

subdomain0 - subdomain99 (opcional)Subdomain records (opcional)

sub_record_type0 - sub_record_type99 (opcional)Os registros de subdomínio devem ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"

sub_record0 - sub_record99 (opcional)Endereço IP ou host alvo

sub_recordx0 - sub_recordx99 (opcional)Distância Mx, tipo de encaminhamento, encaminhamento privado ou alias do e-mail, necessário quando o tipo_desub_registro for "encaminhamento","mx","privado","e-mail"

ttl (opcional)Tempo de existência

enable (opcional)Se quiser aplicar estas configurações de DNS aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"

sync (opcional)Se quiser sincronizar as configurações do servidor DNS de todos os domínios nesta pasta, você pode usar este parâmetro com "yes"

Tag do resultado em XMLExplicação

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 Pasta Dns2 Exemplo

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)

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

Comando de Definição de Pasta para Redirecionamento de E-mails

Support multi-thread

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-mailsExplicação

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

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 XMLExplicação

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"

Set Folder Email Forward Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]

Response (JSON format)

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

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

Support multi-thread

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 PastaExplicação

Parâmetro de Solicitação de Definição de Configuração de Limpeza de Pasta
Explicação

folder_idA ID da pasta que deseja configurar

serviceO serviço que você quer limpar, pode ser "forward", "stealth", "email_forwarding" e "nameservers"

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nó raiz do documento de resposta XML

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

Set Clear Folder Setting Example

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Definição do Nome de Pastas

Support multi-thread

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 PastasExplicação

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 XMLExplicação

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"

Set Folder Name Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new

Response (JSON format)

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

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

Support multi-thread

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çãoExplicação

Parâmetro de Solicitação de Definição da Pasta de Opões de Renovação
Explicação

folder_idA ID da pasta que você deseja definir, apenas 1 pasta pode ser definida por solicitação

renew_optionA opção de renovação que deseja definir para a pasta; pode ser "não renovar", "renovação automática" ou "redefinir".

enable (opcional)Se quiser aplicar estas configurações de renovação aos futuros domínios que você mover para esta pasta, você pode usar este parâmetro com "yes"

sync (opcional)Se quiser sincronizar as configurações de renovação com todos os domínios desta pasta, você pode usar este parâmetro com "yes"

Tag do resultado em XMLExplicação

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"

Set Folder Renew Option Example

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

Response (XML format)

<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>

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

Response (JSON format)

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

Comando de Listagem de Pastas

Support multi-thread

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

Parâmetro de Solicitação de Listagem de PastasExplicação

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

<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

Folder List Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>Yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>

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

Response (JSON format)

{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}

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

Support multi-thread

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 PendentesExplicação

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 XMLExplicação

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"

Add Backorder Request Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response (JSON format)

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

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

Support multi-thread

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 PendentesExplicação

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 XMLExplicação

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"

Delete Backorder Request Example

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

Response (XML format)

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

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

Response (JSON format)

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

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

Support multi-thread

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 PendentesExplicação

Parâmetro de Solicitação de Lista de Solicitação de Domínios Pendentes
Explicação

start_dateData de início do leilão de domínio pendentes que você deseja solicitar, aaaa-mm-dd, como 2015-05-25

end_dateData de encerramento do leilão de domínio pendentes que você deseja solicitar, aaaa-mm-dd, como 2015-05-25

Tag do resultado em XMLExplicação

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

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response (JSON format)

{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response Setor de domínio profissional.

ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active

Comando de Obtenção de Leilões Abertos

Support multi-thread

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 AbertosExplicação

Parâmetro de Solicitação de Obtenção de Leilões Abertos
Explicação

currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano

typeO tipo de leilão que você deseja ver deve ser "expired", "user", "backorder", ou "registry_expired", "registrar",, se deseja obter mais de um tipo de leilão, você pode usar "," para separar cada tipo de leilão.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Marcador da resposta de obtenção de leilões abertos. É o nó raiz do documento de resposta XML

<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Cabeçalho de leilões abertos

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetOpenAuctionsContent></GetOpenAuctionsContent>Marcador de obtenção de conteúdo de leilões abertos, usado apenas quando o status é "success"

<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"

<AuctionId></AuctionId>ID do leilão

<Domain></Domain>Nome de Domínio do leilão

<BidPrice></BidPrice>Preço de lance do leilão atual

<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance

<Bids></Bids>Contagem de lances no leilão

<EndTime></EndTime>Tempo de encerramento do leilão

<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)

<Revenue></Revenue>Receita de leilão

<RevenueCurrency></RevenueCurrency>Moeda da receita

<Visitors></Visitors>Visitantes do domínio

<Links></Links>Links de entrada do domínio

<Age></Age>Idade do domínio

Get Open Auctions Example

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

Response (XML format)

<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>

Solicitação (formato csv)

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

Resposta

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.

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

Response (JSON format)

{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        }
        ...
    ]
}

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

Support multi-thread

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

Parâmetro de Solicitação de Obtenção de Detalhes de LeilãoExplicação

Parâmetro de Solicitação de Obtenção de Detalhes de Leilão
Explicação

domainO nome de domínio de leilão, IDN (Nome de Domínio Internacional) deve usar punycode, como "xn--wkccg.com". Você pode obter mais de um leilão, cada domínio deve ser dividido por ","

currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Marcador da resposta de obtenção de detalhes de leilão. É o nó raiz do documento de resposta XML

<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Cabeçalho das informações do leilão de domínios pendentes

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetAuctionDetailsContent></GetAuctionDetailsContent>Marcador de obtenção de detalhes do conteúdo de leilão, usado somente quando o status for "success"

<AuctionStatusId></AuctionStatusId>ID de status do leilão: '0' para Em andamento, '1' para Cancelado pelo usuário, '2' para Cancelado pelo administrador, '3' para Cancelado em renovação, '4' para Concluído, '5' para Cancelado pela transferência

<AuctionStatus></AuctionStatus>Status do leilão

<UserIsHighBid></UserIsHighBid>Se o usuário deu o maior lance

<YourCurrentBid></YourCurrentBid>Seu preço atual de lance para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'

<YourProxyBid></YourProxyBid>Seu lance automático para um leilão especificado. Caso ainda não tenha dado um lance, será '-1'

<AuctionId></AuctionId>ID do leilão

<Domain></Domain>Nome de Domínio do leilão

<BidPrice></BidPrice>Preço de lance do leilão atual

<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance

<Bids></Bids>Contagem de lances no leilão

<EndTime></EndTime>Tempo de encerramento do leilão

<EndTimestamp></EndTimestamp>Data de encerramento de leilão em tempo Unix (milissegundos desde meia-noite UTC de 1 de janeiro de 1970)

<IsPremium></IsPremium>Se é um domínio premium

<RenewalPrice></RenewalPrice>Preço de renovação

Get Auction Details Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Response (JSON format)

{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}

Comando para obter lances do leilão

Support multi-thread

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

Obter parâmetros de solicitação de lances de leilãoExplicação

Obter parâmetros de solicitação de lances de leilão
Explicação

currency (opcional)A moeda do seu lance. Deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetAuctionBidsResponse></GetAuctionBidsResponse>Tag de resposta de lances de leilão recebidos, é o nó raiz do documento de resposta XML

<GetAuctionBidsHeader></GetAuctionBidsHeader>Obter cabeçalho de lances em leilão

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetAuctionBidsContent></GetAuctionBidsContent>Tag do conteúdo das ofertas de leilão obtidas, é usado somente quando o status é "success"

<BidList></BidList>Lista de lances

<Bid></Bid>Item de Licitação

<BidId></BidId>ID do lance

<AuctionId></AuctionId>ID do leilão

<AccountId></AccountId>Identificação da conta

<Domain></Domain>Nome de Domínio do leilão

<DomainUtf></DomainUtf>Nome utf do leilão de domínio

<AuctionType></AuctionType>Tipo de leilão

<IsIdn></IsIdn>Se este domínio for um Nome de Domínio Internacionalizado

<CurrentBid></CurrentBid>Preço atual da oferta para o leilão

<YourStatus></YourStatus>O status da sua oferta para o leilão

<ProxyBid></ProxyBid>Seu lance de procurador para o leilão

<ActiveBidders></ActiveBidders>A quantidade de licitantes que participam deste leilão

<TimeLeft></TimeLeft>tempo restante para o leilão

<EndTime></EndTime>Tempo limite para o leilão

<EndTimestamp></EndTimestamp>O carimbo de data e hora final para o leilão

Get Auction Bids Example

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

Response (XML format)

<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>

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

Response (JSON format)

{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}

Comando de Colocação de Lance no Leilão

Support multi-thread

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ãoExplicação

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 XMLExplicação

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"

Domain Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (XML format)

<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>

Solicitação (formato csv)

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

Resposta

ok,success

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (JSON format)

{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}

Comando de Obtenção de Leilões Encerrados

Support multi-thread

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 EncerradosExplicação

Parâmetro de Solicitação de Obtenção de Leilões Encerrados
Explicação

start_dateData de início do leilão, aaaa-mm-dd, como 2015-05-25

end_dateData 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 XMLExplicação

Tag do resultado em XML
Explicação

<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Marcador da resposta de obtenção de leilões encerrados. É o nó raiz do documento de resposta XML

<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Cabeçalho de obtenção de leilões encerrados

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetClosedAuctionsContent></GetClosedAuctionsContent>Marcador de obtenção de detalhes do conteúdo de leilão encerrado, usado somente quando o status for "success"

<Auction></Auction>Marcador de item de leilão, usado apenas quando o status é "success"

<AuctionId></AuctionId>ID do leilão

<Domain></Domain>Nome de Domínio do leilão

<AuctionStatusId></AuctionStatusId>Id de status do leilão: '0' para em andamento, '1' para encerrado pelo usuário, '2' para encerrado pelo Admin, '3' para encerrado por renovação, '4' para encerrado por tempo limite e '5' para encerrado por transferência

<AuctionStatus></AuctionStatus>Status do leilão

<BidPrice></BidPrice>Preço de lance do leilão atual

<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance

<Bids></Bids>Contagem de lances no leilão

<AuctionWonStatus></AuctionWonStatus>Se o usuário venceu este leilão

<YourHighBid></YourHighBid>Seu lance mais alto neste leilão

<YourProxyBid></YourProxyBid>Seu lance automático para este leilão

Exemplo de Obtenção de Leilões Encerrados

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (JSON format)

{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response Setor de domínio profissional.

ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0

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

Support multi-thread

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 pendentesExplicação

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 XMLExplicação

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)

Get Open Backorder Auctions Example

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

Response (XML format)

<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>

Solicitação (formato csv)

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

Resposta

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.

Comando para obter as informações do leilão de domínios pendentes

Support multi-thread

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

Parâmetro de Solicitação de Obtenção de Detalhes de LeilãoExplicação

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 XMLExplicação

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"

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

Get Backorder Auction Details Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>

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

Response (JSON format)

{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}

Comando para colocação de lance no leilão de domínios pendentes

Support multi-thread

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 pendentesExplicação

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 XMLExplicação

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"

Place Backorder Auction Bid Example

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (XML format)

<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response (JSON format)

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

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response Setor de domínio profissional.

ok,success

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

Support multi-thread

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 pendentesExplicação

Parâmetro para obter as solicitações do leilão encerrado de domínios pendentes
Explicação

start_dateData de início do leilão, aaaa-mm-dd, como 2015-05-25

end_dateData 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 XMLExplicação

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

<AuctionStatus></AuctionStatus>Status do leilão

<BidPrice></BidPrice>Preço de lance do leilão atual

<BidPriceCurrency></BidPriceCurrency>Moeda do preço de lance

<Bids></Bids>Contagem de lances no leilão

Obter Exemplo de Leilões de Backorder Fechados

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response (JSON format)

{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response Setor de domínio profissional.

ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0

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

Support multi-thread

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

Obter parâmetro de solicitação de domínios de liquidação expiradosExplicação

Obter parâmetro de solicitação de domínios de liquidação expirados
Explicação

currency(optional)A moeda do resultado de retorno deve ser "usd", "eur", ou "cny", a moeda padrão é o dólar dos Estados Unidos.

domain(optional)Adicione esse parâmetro se quiser consultar um domínio de liquidação

count_per_page (optional)Quantas entidades são exibidas por página

page_index (optional)De quais entidades da página você deseja visualizar?

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Tag de resposta de Domínios expirados de liquidação, é o nó raiz da resposta do documento XML

<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Obter Cabeçalho de Domínios de Fechamento Vencidos

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag de conteúdo, só é usada quando o status é 'sucesso'

<CloseoutItem></CloseoutItem>Liquidação

<DomainName></DomainName>O nome de domínio

<DomainNameUtf></DomainNameUtf>O nome de domínio está no formato utf

<CurrentPrice></CurrentPrice>preço atual

<isIdn></isIdn>Se é o nome de domínio idn

<EndTimeStamp></EndTimeStamp>Data de término do leilão em tempo Unix (milissegundos desde a meia-noite UTC de 1º de janeiro de 1970)

<RenewalPrice></RenewalPrice>Preço de renovação

<ExpiredRevenue></ExpiredRevenue>Receita de fechamento

<DynaAppraisal></DynaAppraisal>DynaAvaliação

<InboundLinks></InboundLinks>Links de entrada do domínio

<MonthlyVisitors></MonthlyVisitors>Visitantes do domínio

<Currency></Currency>moeda

Get Expired Closeout Domains Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd

Response (JSON format)

{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}

Comando de compra de domínio de fechamento expirado

Support multi-thread

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

Comprar parâmetro de Solicitação de Domínio de Liquidação ExpiradoExplicação

Comprar parâmetro de Solicitação de Domínio de Liquidação Expirado
Explicação

domainO domínio que você deseja comprar, somente 1 domínio pode ser inserido por solicitação

currency(optional)A moeda do resultado de retorno deve ser "usd", "eur", ou "cny", a moeda padrão é o dólar dos Estados Unidos.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Tag de Compra Encerrada de Domínio Expirado, é o nó raiz do documento XML de resposta.

<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Comprar cabeçalho de domínio de liquidação expirado

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Buy Expired Closeout Domain Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com

Response (JSON format)

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

Receber Comandos de Listagens

Support multi-thread

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

Receber Parâmetros de Pedidos de LIstagemExplicação

Receber Parâmetros de Pedidos de LIstagem
Explicação

currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano

exclude_pending_sale (opcional)Se você não deseja obter listagens bloqueadas para venda pendente, deve ser "yes",, o padrão é "no".

show_other_registrar (opcional)Se você deseja obter outras listagens de registrador, ela deve ser "yes",, o padrão é "no"

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetListingsResponse></GetListingsResponse>O root node do documento XML de respostaXML.

<GetListingsHeader></GetListingsHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetListingsContent></GetListingsContent>Conteúdo da listagem

<Listing></Listing>Conteúdo da listagem de itens

<ListingId></ListingId>Id da Listagem

<Domain></Domain>Nome do domínio

<Price></Price>Preço

<InBoundLinks></InBoundLinks>Contagem de links vinculados

<Age></Age>Idade

Get Listings Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>

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

Response (JSON format)

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

Pedir os Comandos de Listagem de Itens

Support multi-thread

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

Obter parâmetro de solicitação de item de listagemExplicação

Obter parâmetro de solicitação de item de listagem
Explicação

domainO nome de domínio que deseja obter detalhes, apenas um domínio 1 pode ser inserido por solicitação

currency (opcional)Moeda do retorno de resultado, que deve ser "usd", "eur", ou "cny",. A moeda padrão é o Dólar Americano

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetListingItemResponse></GetListingItemResponse>O root node do documento XML de respostaXML.

<GetListingItemHeader></GetListingItemHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<GetListingsItemContent></GetListingsItemContent>Conteúdo da listagem

<Listing></Listing>Conteúdo da listagem de itens

<ListingId></ListingId>Id da Listagem

<Domain></Domain>Nome do domínio

<Price></Price>Preço

<InBoundLinks></InBoundLinks>Contagem de links vinculados

<Age></Age>Idade

Get Listing Item Example

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>

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

Response (JSON format)

{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No"
    }
  }
}

Comando de Compra Instantânea

Support multi-thread

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

Parâmetros de Pedido de Compra INstantâneaExplicação

Parâmetros de Pedido de Compra INstantânea
Explicação

domainO domínio que você deseja comprar, somente 1 domínio pode ser inserido por solicitação

currency (opcional)A moeda de resultado de retorno deve ser "usd", "eur", ou "cny", se nenhuma moeda for inserida, será aplicada a moeda padrão da conta

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<BuyItNowResponse></BuyItNowResponse>O root node do documento XML de respostaXML.

<BuyItNowHeader></BuyItNowHeader>Cabeçalho de resposta

<SuccessCode></SuccessCode>Se a operação é ou não bem-sucedida: "0" em caso de sucesso, "-1" se houver falhado

<Status></Status>Status da solicitação

<Error></Error>Informação de erro sobre a solicitação, usado somente quando o resultado é "error"

<Message></Message>Deveria ser "ordem do domínio criada", só usada quando o status é "sucesso".

Exemplo de Compra Instantânea

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

Response (XML format)

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

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

Response (JSON format)

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

Comando de Venda definido

Support multi-thread

Este comando suporta multi-thread.

Chamar o Comando Definir Para Venda listará seu domínio para venda no Mercado de Domínios. Este comando está disponível apenas em formato XML e JSON. Se chamar este comando, os seguintes parâmetros devem ser incluídos:

Parâmetro de Solicitação de VendaExplicação

Parâmetro de Solicitação de Venda
Explicação

domainsO domínio que deseja listar para venda no Mercado de Domínios, apenas 1 domínio pode ser inserido por solicitação.

for_sale_typeVocê pode escolher um valor da seguinte lista para representar o tipo de venda:
> marketplace:
Liste seu domínio para venda no Marketplace de Domínios. Novas listagens de domínios serão definidas para a categoria, subcategoria e preço inseridos abaixo. Se um preço real for definido, o domínio estará disponível para compra imediata e transferência para o comprador. Mais informações sobre o processo de venda de domínios >

> not_for_sale:
cancelar listagem

listing_type (optional)Você pode escolher um valor da lista a seguir para representar o tipo de vendas através do mercado: (obrigatório se for para venda no marketplace)
> comprar_agora
Definir um preço fixo tornará o domínio disponível para compra imediata e será enviado ao comprador.
Nota: Para domínios em período de carência adicional, se houver venda, ele pode não ser excluído por carência. Mais informações sobre a Exclusão por Carência

> fazer_oferta
Você pode optar por definir um preço mínimo de oferta ou deixar em branco para permitir qualquer quantia de oferta.
Nota: Para domínios em período de carência adicional, se houver venda, ele pode não ser excluído por carência. Mais informações sobre a Exclusão por Carência

> comprar_agora_e_fazer_oferta Definir um preço fixo tornará o domínio disponível para compra imediata e será enviado ao comprador.
Você pode optar por definir um preço mínimo de oferta ou deixar em branco para permitir qualquer quantia de oferta.
Nota: Para domínios em período de carência adicional, se houver venda, ele pode não ser excluído por carência. Mais informações sobre a Exclusão por Carência

price (optional)o preço pelo qual deseja vender seu domínio. (obrigatório se o tipo de venda for marketplace)

minimum_offer (optional)A oferta mínima que você aceitará pelo seu domínio. (obrigatório se o tipo de venda for mercado)

installment (optional)Está permitido o pagamento em parcelas. Se deseja habilitar o pagamento em parcelas, defina-o como "Sim".

maximum_installments (optional)O número máximo de parcelas permitido, somente é utilizado quando a parcela é verdadeira.
Você pode escolher um valor de 2 a 12 para representar os meses máximos para o pagamento da parcela.

category (optional)Escolha uma categoria para o seu domínio. Você pode se referir à tabela de comparação de Categoria e Sub-categoria abaixo para preenchimento opcional.

Sub-category (optional)Escolha uma subcategoria para o seu domínio. Você pode se referir à tabela de comparação de Categoria e Subcategoria abaixo para a seleção.

Description (optional)Descrição do seu domínio

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetForSaleResponse></SetForSaleResponse>O nó raiz da resposta

<SetForSaleHeader></SetForSaleHeader>Cabeçalho de Venda

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Definir Exemplo de Venda

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription

Response (JSON format)

{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}

Definir Comando de Confirmação do Afternic

Support multi-thread

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

Definir parâmetro de solicitação de confirmação de ação AfternicExplicação

Definir parâmetro de solicitação de confirmação de ação Afternic
Explicação

domainO domínio que deseja definir ação de transferência rápida no Afternic, apenas 1 domínio pode ser inserido por solicitação.

actionA ação que você deseja definir para confirmar Afternic deve ser "confirm_afternic", ou "delete_from_afternic".

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Tag de confirmação de ação Afternic Set, é o nó raiz da resposta XML do documento.

<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Definir cabeçalho de ação de confirmação Afternic

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Set Afternic Confirm Action Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic

Response (JSON format)

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

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

Support multi-thread

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

Definir Parâmetro de Solicitação de Ação de Confirmação da SedoExplicação

Definir Parâmetro de Solicitação de Ação de Confirmação da Sedo
Explicação

domainO domínio que você deseja definir o Sedo confirma a ação de transferência rápida, apenas 1 domínio pode ser inserido por solicitação.

actionA ação que você deseja definir como confirmada na sedo deve ser "confirm_sedo", ou "delete_from_sedo".

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Tag da resposta de confirmação da ação do Set Sedo, é o nó raiz do documento de resposta XML

<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>Definir cabeçalho de ação de confirmação Sedo

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

Set Sedo Confirm Action Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo

Response (XML format)

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

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo

Response (JSON format)

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

Comando de Lista de Pedidos

Support multi-thread

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

Parâmetro de solicitação de lista de pedidosExplicação

Parâmetro de solicitação de lista de pedidos
Explicação

search_byVocê pode escolher um valor da seguinte lista para representar seu tipo de busca: date_range, domain, order_id

start_datea data de início da sua consulta no formato yyyy/MM/dd

end_datea data de término da sua consulta no formato aaaa/MM/dd

payment_methodVocê pode escolher vários valores da seguinte lista para representar seu método de pagamento: none_balance account_balance credit_card money_order paypal moneybookers bank_wire alipay payflow_credit_card2 (Não mais usado) wechat_pay ecash bank_transfer apple_pay checking_account sale union_pay paypal_account mercado_pago payoneer mas por favor, use vírgula para separar múltiplos valores, por exemplo: account_balance,credit_card.

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<OrderListResponse></OrderListResponse>O nó raiz da resposta

<OrderListHeader></OrderListHeader>Cabeçalho da lista de pedidos

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

<OrderListContent></OrderListContent>Cabeçalho da lista de pedidos

<OrderList></OrderList>Contém vários conjuntos de dados de registro de pedidos

<OrderItem></OrderItem>Contém dados de registro de pedido único

<OrderItemDomain></OrderItemDomain>O nome de domínio que inclui os itens nesta ordem

<OrderId></OrderId>Contém o ID do pedido

<SubmittedDate></SubmittedDate>Contém a data em que o pedido foi enviado

<Cost></Cost>Contém o custo do pedido

<Status></Status>Contém o status do pedido

Exemplo de Lista de Pedidos

Request (XML format) https://api.dynadot.com/api3.xml?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1734829556707</SubmittedDate>
        <Currency>USD</Currency>
        <PaymentMethod>Account Balance</PaymentMethod>
        <TotalCost>$8.00</TotalCost>
        <TotalPaid>$8.00</TotalPaid>
        <Status>Problem</Status>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test.com</Name>
          <Duration>1</Duration>
          <Cost>2.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test1.ac</Name>
          <Duration>1</Duration>
          <Cost>3.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test2.de</Name>
          <Duration>1</Duration>
          <Cost>4.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test3.gg</Name>
          <Duration>1</Duration>
          <Cost>5.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test4.uk</Name>
          <Duration>1</Duration>
          <Cost>6.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test5.net</Name>
          <Duration>1</Duration>
          <Cost>7.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
      </Order>
      <Order>
        <OrderId>123457</OrderId>
        <SubmittedDate>1734829556707</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card

Response (JSON format)

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

Comando para obter o status do pedido

Support multi-thread

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

Parâmetro de solicitação de status do pedidoExplicação

Parâmetro de solicitação de status do pedido
Explicação

order_idO ID do pedido a ser consultado

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<GetOrderStatusResponse></GetOrderStatusResponse>O nó raiz da resposta

<GetOrderStatusHeader></GetOrderStatusHeader>Obter cabeçalho de status do pedido

<ResponseCode></ResponseCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

<GetOrderStatusContent></GetOrderStatusContent>conteúdo de resposta

<OrderId></OrderId>ID do pedido

<OrderStatus></OrderStatus>status do pedido (compra, enviado, aguardando pagamento, processando, concluído, problema, excluído, cancelado)

<ItemTypeName></ItemTypeName>Tipo de item

<ItemName></ItemName>Nome do item

<ItemStatus></ItemStatus>Estado do item (Concluído, Cancelado, Problema)

Get Order Status Example

Request (XML format) https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>

Request (JSON format)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0

Response (JSON format)

{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}

Comando de em processamento (is processing)

Support multi-thread

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

Parâmetro de Solicitação de em ProcessamentoExplicação

Parâmetro de Solicitação de em Processamento
Explicação

nenhum parâmetro adicional é necessário

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<Response></Response>Marcador de resposta de is_processing

<ResponseHeader></ResponseHeader>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).

Is-Processing Example

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

Response (XML format)

<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>

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

Response (JSON format)

{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}

Request Setor de domínio profissional.https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing

Response Setor de domínio profissional.

ok,yes

Listar Cupons Comando

Support multi-thread

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

Lista de Parâmetros de Solicitação de CuponsExplicação

Lista de Parâmetros de Solicitação de Cupons
Explicação

coupon_typeVocê pode escolher um valor da seguinte lista para representar seu tipo de busca: "registration" , "renewal" , ou "transfer"

Tag do resultado em XMLExplicação

Tag do resultado em XML
Explicação

<ListCouponsResponse></ListCouponsResponse>O nó raiz da resposta

<ListCouponsHeader></ListCouponsHeader>Lista de Cupons

<SuccessCode></SuccessCode>Se a operação for bem-sucedida, "0" para sucesso, "-1" para falha

<Status></Status>Status da solicitação

<Error></Error>Informações de erro sobre a solicitação, usado apenas quando o status é "erro"

<ListCouponsContent></ListCouponsContent>Listar o conteúdo dos Cupons

<Coupons></Coupons>Contém múltiplos conjuntos de dados de cupons

<Coupon></Coupon>Contém dados de cupom único

<Code></Code>Código do cupom

<Description></Description>Descrição do cupom

<CouponType></CouponType>Tipo do cupom

<DiscountType></DiscountType>Tipo de desconto oferecido pelo cupom

<DiscountInfo></DiscountInfo>As informações de desconto do cupom

<Percentage></Percentage>A porcentagem do desconto

<AUD></AUD>Valor do desconto em Dólares Australianos

<MXN></MXN>Valor do desconto em Pesos Mexicanos

<EUR></EUR>Valor do desconto em Euros

<GBP></GBP>Valor do desconto em libras esterlinas

<IDR></IDR>Valor do desconto em Rupias Indonésias

<USD></USD>Valor do desconto em Dólares Americanos

<CAD></CAD>Valor do desconto em Dólares Canadenses

<INR></INR>Valor do desconto em rúpias indianas

<BRL></BRL>Valor do desconto em Real Brasileiro

<CNY></CNY>Valor do desconto em Yuan Chinês

<Restriction></Restriction>Restrições de cupom

<PriceLevels></PriceLevels>Uma coleção de níveis de preço que suportam o uso de cupons

<UsesPerAccount></UsesPerAccount>O número de vezes que o cupom pode ser usado por conta

<UsesSystemWide></UsesSystemWide>O número de vezes que o cupom pode ser usado em todo o sistema

<UsesPerIp></UsesPerIp>O número de vezes que o cupom pode ser usado por endereço IP

<ItemsPerAccount></ItemsPerAccount>O número de itens para os quais o cupom pode ser usado por conta

<ItemsSystemWide></ItemsSystemWide>O número de itens para os quais o cupom pode ser usado em todo o sistema

<ItemsPerOrder></ItemsPerOrder>O número de itens para os quais o cupom pode ser usado por pedido

<ItemsPerDay></ItemsPerDay>O número de itens para os quais o cupom pode ser usado por dia

<IdnRestriction></IdnRestriction>Restrições de IDN para o cupom

<DomainDurationMin></DomainDurationMin>Duração mínima do domínio

<DomainDurationMax></DomainDurationMax>Duração máxima do domínio

<Tlds></Tlds>Uma coleção de domínios de nível superior que suportam o uso de cupons

<Tld></Tld>Um único domínio de nível superior que suporta o uso de cupons

<Currencies></Currencies>Uma coleção de tipos de moeda que suportam o uso de cupons

<Currency></Currency>Um único tipo de moeda que suporta o uso de cupons

<StartDate></StartDate>A data de início da validade do cupom

<EndDate></EndDate>A data de término da validade do cupom

Lista de Cupons Exemplo

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

Response (XML format)

<?xml version="1.0" encoding="UTF-8"?>
<ListCouponsResponse>
  <ListCouponsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </ListCouponsHeader>
  <ListCouponsContent>
    <Coupons>
      <Coupon>
        <Code>DOMAINRENEW1</Code>
        <Description>Domain Renew Coupon</Description>
        <CouponType>Hosting/SSL Coupons</CouponType>
        <DiscountType>PERCENTAGE_OFF</DiscountType>
        <DiscountInfo>
          <Percentage>10%</Percentage>
        </DiscountInfo>
        <Restriction>
          <PriceLevels>Any</PriceLevels>
          <IdnRestriction>None</IdnRestriction>
          <DomainDurationMin>1</DomainDurationMin>
          <DomainDurationMax>1</DomainDurationMax>
          <Tlds>
            <Tld>.com</Tld>
            <Tld>.net</Tld>
            <Tld>.org</Tld>
          </Tlds>
          <Currencies>
            <Currency>US Dollar USD ($)</Currency>
          </Currencies>
        </Restriction>
        <StartDate>1476811260000</StartDate>
        <EndDate>1483257540000</EndDate>
      </Coupon>
    </Coupons>
  </ListCouponsContent>
</ListCouponsResponse>

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

Response (JSON format)

{
  "ListCouponsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Coupons": [
      {
        "Code": "DOMAINRENEW1",
        "Description": "Domain Renew Coupon",
        "CouponType": "Hosting/SSL Coupons",
        "DiscountType": "PERCENTAGE_OFF",
        "DiscountInfo": {
          "Percentage": "10%"
        },
        "Restriction": {
          "PriceLevels": "Any",
          "IdnRestriction": "None",
          "DomainDurationMin": "1",
          "DomainDurationMax": "1",
          "Tlds": [
            ".com",
            ".net",
            ".org"
          ],
          "Currencies": [
            "US Dollar USD ($)"
          ]
        },
        "StartDate": "1476811260000",
        "EndDate": "1483257540000"
      }
    ]
  }
}

Chat Online

Conversas atuais em fila de espera:0

Chat Online0