Domaines

Liste des commandes de l'API Domaine

Notre API est votre boîte à outils avancée de gestion et d'acquisition de domaines, conçue pour l'efficacité. Avec plus de 50 commandes pour configurer, gérer, enregistrer et enchérir sur toute la plateforme Dynadot, vous aurez un contrôle total sur votre compte et les paramètres de vos domaines, quel que soit le logiciel API de votre choix. Notre API de domaine est disponible pour tous les comptes, alors commencez dès aujourd'hui !

Premiers pas avec notre API de domaine avancée

API héritée, prévue pour être retirée. Veuillez plutôt utiliser notre API RESTful :

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

Les requêtes vers notre API de domaine avancée sont envoyées à l'URL suivante :

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

Les requêtes doivent être envoyées via https (socket sécurisée) pour des raisons de sécurité. La requête doit contenir les deux paramètres suivants : un 'Key' et un 'Command'. Chaque commande peut être cliquée pour afficher les paramètres qui lui sont associés.

Vous recevrez différents nombres de threads en fonction du niveau de dépenses de votre compte:

Niveau de dépensesNombre de threadsLimite de débit
Régulier1 thread60/min (1/s)
Bulk5 threads600/min (10/sec)
super en masse35 threads6000/min (100/sec)
 
Paramètre de requête
Explication
KeyVotre clé pour accéder à l'API, disponible dans le panneau de configuration de votre compte Dynadot sous le menu latéral 'Outils' -> 'API'.
Command
Domaine :
search, register, delete, renew, push, transfer, bulk_register, restore

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

cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_domain_push_request, set_domain_push_request
contact:
create_cn_audit, get_cn_audit_status, create_contact, edit_contact, delete_contact, contact_list, get_contact

set_contact_eu_setting, set_contact_lv_setting, set_contact_lt_setting
Serveur de noms:
get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns
Compte :
account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, set_default_email_forward, set_clear_default_setting, set_default_renew_option
Dossier :
create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_dns2, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list
Marché secondaire:
add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, get_auction_bids, place_auction_bid, get_closed_auctions

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions, get_expired_closeout_domains, buy_expired_closeout_domain, get_listings, get_listing_item, buy_it_now, add_new_lead
Autre :
set_afternic_confirm_action, set_sedo_confirm_action, get_whois_stats, order_list, set_for_sale, get_order_status, is_processing, transfer_out_domain_list, list_coupons, download_all_listings

Format XML. La réponse que vous recevez doit contenir 2 ou 3 des champs suivants :

Balise XML de résultat
Explication
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
 

Commande de recherche

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de recherche, les paramètres suivants doivent être inclus :

Paramètre de demande de recherche
Explication
domain0 - domain99Le nom de domaine que vous recherchez, un compte standard peut spécifier 1 domaine par commande, un compte bulk et super bulk peut spécifier jusqu'à 100 domaines
language0 - language99 (optional)L'étiquette de langue du domaine respectif, à n'utiliser que pour les IDNs.
show_price (optional)Si vous souhaitez afficher le prix dans la devise de votre compte, définissez-le sur "1". Si le domaine est disponible, ses détails premium et ses informations de prix seront affichés.
currency (optional)Vous pouvez choisir le type de devise et les valeurs prises en charge pour ce paramètre sont "USD","CNY", "GBP","EUR","INR","CAD" etc. Si vous omettez ce paramètre, nous utiliserons la devise par défaut du compte.
Balise XML de résultat
Explication
<Results></Results>Le nœud racine de la réponse XML de la commande de recherche
<SearchResponse></SearchResponse>Tag de la réponse de recherche
<SearchHeader></SearchHeader>Étiquette de l'en-tête de recherche
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<DomainName></DomainName>Le nom de domaine que vous venez de rechercher
<Available></Available>Si le nom de domaine est disponible
<Price></Price>Si vous définissez "show_price" sur "1", cela vous indiquera les informations de prix si ce domaine est disponible.
<Language></Language>Informations linguistiques sur le nom de domaine

Exemple de recherche

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Réponse (format XML)
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Available>yes</Available>
      <Price>77.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Available>yes</Available>
      <Price>44.00 in USD and domain is not premium</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1&currency=USD
Réponse (format JSON)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

Commande Register

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

L'appel de la commande register va créer et traiter une commande d'enregistrement. Vous devez disposer d'un solde de compte suffisant pour payer la commande. Si vous appelez la commande register, les paramètres suivants doivent être inclus :

Paramètre de requête d'enregistrement
Explication
domainLe nom de domaine que vous voulez enregistrer, un seul domaine peut être enregistré par requête
language (optional)L'étiquette de langue du domaine demandé, nécessaire uniquement si le domaine est un IDN
durationPour quelle durée enregistrer le domaine
registrant_contact (optional)Le contact du titulaire que vous souhaitez utiliser pour le domaine
admin_contact (optional)Le contact administrateur que vous souhaitez utiliser pour le domaine
technical_contact (optional)Le contact technique que vous souhaitez utiliser sur le domaine
billing_contact (optional)Le contact de facturation que vous souhaitez utiliser sur le domaine
option0 (if necessary)
Le nom du titulaire .AT, .BE,
option1 (if necessary)L'organisation du titulaire pour .AT, .BE (facultatif)
Pour .AT, vous pouvez spécifier soit option0, soit option1, ou les deux
premium (optional)Si vous souhaitez enregistrer un domaine premium, définissez-le sur "1" (facultatif)
currency (optional)Vous pouvez choisir le type de devise et les valeurs prises en charge pour ce paramètre sont "USD","CNY", "GBP","EUR","INR","CAD" etc. Si vous omettez ce paramètre, nous utiliserons la devise par défaut du compte.
coupon (optional)Le code promo que vous souhaitez appliquer à cette commande
Balise XML de résultat
Explication
<RegisterResponse></RegisterResponse>Balise de la réponse d'enregistrement
<RegisterHeader></RegisterHeader>Balise de l'en-tête de registre
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<RegisterContent></RegisterContent>Le tag du contenu d'enregistrement
<Expiration></Expiration>Date d'expiration en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970), utilisée uniquement lorsque le résultat est "success"
<Registration></Registration>Date d'enregistrement en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970), utilisée uniquement lorsque le résultat est "success"

Exemple d'enregistrement

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register&domain=domain1.net&duration=3&currency=USD
Réponse (format JSON)
{
  "RegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.net",
    "Expiration": 1458379145266
  }
}
 

Commande de suppression

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande delete supprimera un domaine qui est encore dans la période de grâce. Le montant des frais d'enregistrement sera recrédité sur le solde de votre compte. Les domaines qui ont été renouvelés ou qui ont été déplacés vers un nouveau compte ne peuvent pas être supprimés via l'API. Si vous appelez la commande delete, les paramètres suivants doivent être inclus :

Paramètre de requête de suppression
Explication
domainLe nom de domaine que vous voulez supprimer, seulement 1 domaine peut être supprimé par requête
Balise XML de résultat
Explication
<DeleteResponse></DeleteResponse>Tag de la réponse de suppression
<DeleteHeader></DeleteHeader>Étiquette de l'en-tête de suppression
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de suppression

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete&domain=domain1.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete&domain=domain1.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete&domain=domain1.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete&domain=domain1.com
Réponse (format JSON)
{
  "DeleteResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainName": "domain1.com"
  }
}
 

Commande de renouvellement

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande renew créera et traitera une commande de renouvellement. Vous devez avoir suffisamment de solde sur votre compte pour payer la commande. Si vous appelez la commande renew, les paramètres suivants doivent être inclus :

Paramètre de la requête de renouvellement
Explication
domainLe nom de domaine que vous voulez renouveler, un seul domaine peut être renouvelé par requête
durationNombre d'années pour renouveler le domaine
year (optional)L'année actuelle d'expiration du domaine
currency (optional)Vous pouvez choisir le type de devise et les valeurs prises en charge pour ce paramètre sont "USD","CNY", "GBP","EUR","INR","CAD" etc. Si vous omettez ce paramètre, nous utiliserons la devise par défaut du compte.
price_check (optional)Vous pouvez ajouter ce paramètre à la commande pour vérifier le détail du prix pour renouveler ce domaine. REMARQUE : L'ajout de ce paramètre à la commande ne renouvellera pas le domaine via notre API, mais affichera uniquement les informations de prix.
coupon (optional)Le code promo que vous souhaitez appliquer à cette commande
no_renew_if_late_renew_fee_needed (optional)Vous pouvez ajouter ce paramètre à la commande pour éviter le renouvellement si le domaine nécessite des frais de renouvellement tardif. Si le domaine nécessite des frais de renouvellement tardif pour être renouvelé, et que "no_renew_if_late_renew_fee_needed = 1" a été passé dans la commande, le domaine ne sera pas renouvelé.
Balise XML de résultat
Explication
<RenewResponse></RenewResponse>Balise de la réponse de renouvellement, c'est le nœud racine du document XML de réponse
<RenewHeader></RenewHeader>En-tête de renouvellement
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<PriceInfo></PriceInfo>Étiquette des informations de prix, elle n'est utilisée que lorsque le statut est "price_check_success"
<RenewContent></RenewContent>Étiquette du contenu de renouvellement, elle n'est utilisée que lorsque le statut est "success"
<Expiration></Expiration>Date d'expiration en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970), utilisée uniquement lorsque le résultat est "success"

Exemple de renouvellement

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Réponse (format XML)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon
Réponse (format JSON)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
      "Expiration":"73984579834"
   }
}
 

Commande Push

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande push créera et traitera un ordre de push. Vous devez déverrouiller votre domaine et votre compte pour l'ordre. Le compte destinataire doit rejeter/accepter le domaine pour finaliser l'ordre. Si vous appelez la commande push, les paramètres suivants doivent être inclus :

Paramètre de requête Push
Explication
domainLe nom de domaine que vous souhaitez transférer. Nous prenons également en charge le transfert en masse, vous pouvez utiliser ";" pour séparer les domaines. Exemple : domain1.com;domain2.com
receiver_push_usernameNom d'utilisateur Push du compte destinataire
currency (optional)Vous pouvez choisir le type de devise et les valeurs prises en charge pour ce paramètre sont "USD","CNY", "GBP","EUR","INR","CAD" etc. Si vous omettez ce paramètre, nous utiliserons la devise par défaut du compte.
unlock_domain_for_push(optional)Définissez ce paramètre sur "1". Si le domaine est verrouillé, nous le déverrouillerons automatiquement, vous n'avez donc pas à déverrouiller le domaine manuellement
receiver_email(optional)E-mail push du compte destinataire
Balise XML de résultat
Explication
<PushResponse></PushResponse>Balise de la réponse push, c'est le nœud racine du document XML de réponse
<PushHeader></PushHeader>En-tête push
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de push

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Réponse (format XML)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=push&domain=domian1.com&receiver_push_username=username&currency=USD
Réponse (format JSON)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

Commande de transfert

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande de transfert créera et traitera un ordre de transfert. Certains tlds peuvent nécessiter que le registrar perdant confirme pour terminer l'ordre. Si vous appelez la commande de transfert, les paramètres suivants doivent être inclus :

Paramètre de la requête de transfert
Explication
domainLe nom de domaine que vous souhaitez transférer vers Dynadot, un seul domaine peut être transféré par demande
authLe code d'autorisation pour la demande de transfert.
currency (optional)Vous pouvez choisir le type de devise et les valeurs prises en charge pour ce paramètre sont "USD","CNY", "GBP","EUR","INR","CAD" etc. Si vous omettez ce paramètre, nous utiliserons la devise par défaut du compte.
registrant_contact (optional)Le contact du titulaire que vous souhaitez utiliser lorsque le transfert est terminé. (Tous les TLD ne prennent pas en charge cette fonctionnalité)
admin_contact (optional)Le contact administrateur que vous souhaitez utiliser une fois le transfert terminé. (Tous les TLD ne prennent pas en charge cette fonctionnalité)
technical_contact (optional)Le contact technique que vous souhaitez utiliser une fois le transfert terminé. (Tous les tld ne prennent pas en charge cette fonctionnalité)
billing_contact (optional)Le contact de facturation que vous souhaitez utiliser une fois le transfert terminé. (Tous les tld ne prennent pas en charge cette fonctionnalité)
premium (optional)Si vous souhaitez transférer un domaine premium, définissez-le sur "1" (facultatif)
privacy (optional)Le statut de confidentialité du domaine que vous souhaitez définir peut être "on" ou "off". Le niveau de confidentialité par défaut du compte sera appliqué en cas de saisie incorrecte ou absente
name_servers (optional)La liste des serveurs de noms à appliquer au domaine une fois le transfert terminé. Vous pouvez utiliser "," pour séparer les serveurs de noms. Exemple : ns1.domain1.com,ns2.domain2.com
coupon (optional)Le code promo que vous souhaitez appliquer à cette commande
Balise XML de résultat
Explication
<TransferResponse></TransferResponse>Balise de réponse de transfert, c'est le nœud racine du document XML de réponse
<TransferHeader></TransferHeader>En-tête de transfert
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de transfert

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
    <DomainName>domain1.com</DomainName>
    <OrderId>1234567</OrderId>
  </TransferHeader>
</TransferResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon
Réponse (format JSON)
{
  "TransferResponse": {
    "ResponseCode": 0,
    "Status": "order created",
    "DomainName": "domain1.com",
    "OrderId": "1234567"
  }
}
 

Commande d'enregistrement en masse

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

L'appel de la commande d'enregistrement en masse créera et traitera les commandes d'enregistrement. Vous devez avoir suffisamment de solde sur votre compte pour payer les commandes. Si vous appelez la commande d'enregistrement en masse, les paramètres suivants doivent être inclus :

Paramètre de requête d'enregistrement en masse
Explication
domain0-domain99Le ou les noms de domaine que vous souhaitez enregistrer, un maximum de 100 domaines peut être enregistré par requête
premium (optional)Si vous souhaitez enregistrer un domaine premium, définissez-le sur "1" (facultatif)
currency (optional)Vous pouvez choisir le type de devise et les valeurs prises en charge pour ce paramètre sont "USD","CNY", "GBP","EUR","INR","CAD", etc. Si vous omettez ce paramètre, nous utiliserons la devise par défaut du compte
coupon (optional)Le code promo que vous souhaitez appliquer à cette commande
Balise XML de résultat
Explication
<BulkRegisterResponse></BulkRegisterResponse>Balise de la réponse d'enregistrement en masse
<BulkRegisterHeader></BulkRegisterHeader>Balise d'en-tête d'enregistrement en masse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<BulkRegisterContent></BulkRegisterContent>Le tag du contenu d'enregistrement en masse
<Expiration></Expiration>Date d'expiration en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970), utilisée uniquement lorsque le résultat est "success"
<Result></Result>Le résultat de l'action d'enregistrement
<Message></Message>Message d'erreur de l'action d'enregistrement, utilisé uniquement lorsque le résultat est "error"

Exemple de Bulk Register

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
  <BulkRegisterHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BulkRegisterHeader>
  <BulkRegisterContent>
    <BulkRegister>
      <RegisterResult>
        <DomainName>domain0.com</DomainName>
        <Expiration>1234567890</Expiration>
        <Result>success</Result>
        <Message>-</Message>
      </RegisterResult>
      <RegisterResult>
        <DomainName>domain1.com</DomainName>
        <Expiration>-</Expiration>
        <Result>error</Result>
        <Message>not_available</Message>
      </RegisterResult>
    </BulkRegister>
  </BulkRegisterContent>
</BulkRegisterResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD
Réponse (format JSON)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

Commande d'information sur le domaine

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête d'informations sur le domaine
Explication
domainUn seul domaine autorisé par requête
Balise XML de résultat
Explication
<DomainInfoResponse></DomainInfoResponse>Nœud racine du document XML de réponse
<DomainInfoResponseHeader></DomainInfoResponseHeader>En-tête de réponse
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<DomainInfoContent></DomainInfoContent>Contenu de la réponse
<Domain></Domain>Domaine
<Name></Name>Nom du domaine
<Expiration></Expiration>Date d'expiration du domaine en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<Registration></Registration>Date d'enregistrement du domaine en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<NameServerSettings></NameServerSettings>Paramètres des serveurs de noms du domaine
<Type></Type>Type de serveur de noms du domaine
<WithAds></WithAds>Si vous souhaitez une page de parking pour votre domaine
<Whois></Whois>Informations Whois
<Registrant></Registrant>Informations sur le titulaire
<ContactId></ContactId>ID du contact
<Admin></Admin>Informations d'administrateur
<Technical></Technical>Informations techniques
<Billing></Billing>Informations de facturation
<Locked></Locked>Verrouillé ou non
<Disabled></Disabled>Statut d'activation
<UdrpLocked></UdrpLocked>Udrp verrouillé ou non
<UdrpLocked></UdrpLocked>Udrp verrouillé ou non
<RegistrantUnverified></RegistrantUnverified>Titulaire non vérifié
<Hold></Hold>Statut de blocage Client/Registrar
<Privacy></Privacy>Statut de confidentialité
<isForSale></isForSale>Statut de vente
<RenewOption></RenewOption>Option de renouvellement
<Note></Note>Note
<Folder></Folder>Informations sur le dossier
<FolderId></FolderId>ID du dossier
<FolderName></FolderName>Nom du dossier

Exemple d'informations de domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=domain_info&domain=domain1.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
  <DomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </DomainInfoHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1361430589062</Expiration>
      <Registration>1234567890123</Registration>
      <NameServerSettings>
        <Type>Dynadot Parking</Type>
        <WithAds>Yes</WithAds>
      </NameServerSettings>
      <Whois>
        <Registrant>
          <ContactId>0</ContactId>
        </Registrant>
        <Admin>
          <ContactId>0</ContactId>
        </Admin>
        <Technical>
          <ContactId>0</ContactId>
        </Technical>
        <Billing>
          <ContactId>0</ContactId>
        </Billing>
      </Whois>
      <Locked>yes</Locked>
      <Disabled>no</Disabled>
      <UdrpLocked>no</UdrpLocked>
      <RegistrantUnverified>no</RegistrantUnverified>
      <Hold>no</Hold>
      <Privacy>none</Privacy>
      <isForSale>yes</isForSale>
      <RenewOption>no renew option</RenewOption>
      <Note/>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
      <Status>active</Status>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=domain_info&domain=domain1.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=domain_info&domain=domain1.com
Réponse (format JSON)
{
  "DomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainInfo": {
      "Name": "domain1.com",
      "Expiration": "1361430589062",
      "Registration": "1234567890123",
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      },
      "Whois": {
        "Registrant": {
          "ContactId": "0"
        },
        "Admin": {
          "ContactId": "0"
        },
        "Technical": {
          "ContactId": "0"
        },
        "Billing": {
          "ContactId": "0"
        }
      },
      "Locked": "yes",
      "Disabled": "no",
      "UdrpLocked": "no",
      "RegistrantUnverified": "no",
      "Hold": "no",
      "Privacy": "none",
      "isForSale": "yes",
      "RenewOption": "no renew option",
      "Note": "",
      "Folder": {
        "FolderId": "-1",
        "FolderName": "(no folder)"
      },
      "Status": "active"
    }
  }
}
 

Commande de définition Whois

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set Whois, les paramètres suivants doivent être inclus:

Définir le paramètre de requête Whois
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
registrant_contactLes informations du titulaire du domaine
admin_contactLes informations de l'administrateur du domaine
technical_contactLes informations techniques du domaine
billing_contactLes informations de facturation du domaine
Balise XML de résultat
Explication
<SetWhoisResponse></SetWhoisResponse>Nœud racine du document XML de réponse
<SetWhoisHeader></SetWhoisHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de Set Whois

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Réponse (format XML)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Réponse (format JSON)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition des serveurs de noms

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition des serveurs de noms, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir les serveurs de noms
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
ns0 - ns12Les serveurs de noms à configurer pour votre domaine, vous pouvez en spécifier jusqu'à 13, mais ils doivent déjà être dans votre compte
Balise XML de résultat
Explication
<SetNsResponse></SetNsResponse>Balise de la réponse de définition du serveur de noms, c'est le nœud racine du document XML de réponse
<SetNsHeader></SetNsHeader>Balise de l'en-tête de réponse de définition du serveur de noms
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition des NS

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Réponse (format JSON)
{
  "SetNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de définition du parking

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du parking, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir le parking
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
with_ads (optional)Si vous ne voulez pas d'annonces tierces, vous pouvez utiliser ce paramètre avec "no"
Balise XML de résultat
Explication
<SetParkingResponse></SetParkingResponse>Balise de la réponse set parking, c'est le nœud racine du document XML de réponse
<SetParkingHeader></SetParkingHeader>En-tête de définition du dossier de parking
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration de parking

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
Réponse (format XML)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_parking&domain=domain1.com&with_ads=no
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_parking&domain=domain1.com&with_ads=no
Réponse (format JSON)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de configuration du transfert

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set forwarding, les paramètres suivants doivent être inclus:

Définir le paramètre de requête de redirection
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
forward_urlL'URL vers laquelle vous voulez que votre domaine redirige. Veuillez noter que le paramètre doit être encodé afin que l'appel API soit interprété correctement.
is_temp (optional)Statut de redirection souhaité pour votre domaine, la valeur par défaut est "temporary", si vous souhaitez rediriger définitivement, utilisez ce paramètre avec "no"
Balise XML de résultat
Explication
<SetForwardingResponse></SetForwardingResponse>Nœud racine du document XML de réponse
<SetForwardingHeader></SetForwardingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration de redirection

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Réponse (format XML)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com
Réponse (format JSON)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Définir la commande furtive

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Lors de l'appel de la commande set stealth, les paramètres suivants doivent être inclus :

Définir le paramètre de requête furtive
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
stealth_urlL'URL vers laquelle vous voulez que votre domaine redirige. Veuillez noter que le paramètre doit être encodé afin que l'appel API soit interprété correctement.
stealth_title (optional)Le titre de la page
Balise XML de résultat
Explication
<SetStealthResponse></SetStealthResponse>Nœud racine du document XML de réponse
<SetStealthHeader></SetStealthHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple Set Stealth

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Réponse (format XML)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Réponse (format JSON)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition de l'hébergement

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set hosting, les paramètres suivants doivent être inclus :

Paramètre de requête de définition de l'hébergement
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
hosting_typeType d'hébergement souhaité, vous pouvez choisir entre "advanced" et "basic"
mobile_view_onCe n'est que lorsque hosting_type est "advanced" que vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetHostingResponse></SetHostingResponse>Nœud racine du document XML de réponse
<SetHostingHeader></SetHostingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration d'hébergement

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Réponse (format XML)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Réponse (format JSON)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set DNS2

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set DNS2, les paramètres suivants doivent être inclus :

Veuillez noter que l'exécution de la commande SET_DNS2 écrasera par défaut les paramètres DNS actuels. Pour modifier ce comportement et ajouter plutôt les nouveaux paramètres DNS, vous pouvez utiliser le paramètre facultatif add_dns_to_current_setting.

Définir le paramètre de requête DNS2
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
main_record_type0 - main_record_type19 (optional)Type d'enregistrement principal, doit être "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Spécifiez l'enregistrement DNS pour votre domaine
main_recordx0 - main_recordx19Distance MX, type de redirection (301 comme "1", 302 comme "2"), titre de redirection masquée ou alias e-mail, nécessaire lorsque main_record_type est "forward","mx","stealth","email".
subdomain0 - subdomain99 (optional)Enregistrements de sous-domaine (facultatif)
sub_record_type0 - sub_record_type99Type d'enregistrement de sous-domaine, doit être "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99Adresse IP du sous-domaine ou hôte cible
sub_recordx0 - sub_recordx99Distance MX, type de redirection, titre de redirection furtive ou alias e-mail, nécessaire lorsque main_record_type est "forward","mx","stealth","email"
ttl (optional)Durée de vie
add_dns_to_current_setting (optional)si vous voulez ajouter les nouveaux paramètres DNS aux paramètres DNS existants. Définissez-le sur "1" (facultatif)
Balise XML de résultat
Explication
<SetDnsResponse></SetDnsResponse>Nœud racine du document XML de réponse
<SetDnsHeader></SetDnsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration DNS2

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Réponse (format JSON)
{
  "SetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de définition DNSSEC

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande Set Dnssec définira le dnssec du domaine. Cette commande n'est disponible qu'au format XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Vous pouvez choisir de renseigner les valeurs de paramètre correspondantes dans l'Option en fonction de votre nom de domaine.

Option 1 : domain_name , key_tag , digest_type , digest , algorithm

Option 2 : domain_name , flags , public_key , algorithm

Remarques : veuillez sélectionner le numéro du libellé correspondant comme valeur de votre paramètre, le cas échéant.

Paramètre de requête Set Dnssec
Explication
domain_nameLe nom de domaine pour lequel vous devez configurer DNSSEC
key_tagÉtiquette de clé
digest_typeVous pouvez choisir un nombre dans la liste suivante pour représenter votre type de signature numérique : SHA-1(1) SHA-256(2) GOSTR 34.11-94 (3) SHA-384(4)
digestVeuillez saisir la valeur correspondant au type de digest que vous avez sélectionné
algorithmVous pouvez choisir un numéro dans la liste suivante pour représenter votre algorithme de signature numérique : RSA/MD5(1) Diffie-Hellman (2) DSA/SHA-1(3) Courbe elliptique (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 Courbe P-256 avec SHA-256(13 ECDSA Courbe P-384 avec SHA-384(14) ED25519(15 ED448(16) Indirect (252) DNS privé (253 OID privé (254)
flagsVous pouvez choisir un nombre dans la liste suivante pour représenter le symbole de votre signature numérique : ZSK(256) KSK(257)
public_keyLa clé publique doit être en encodage base64.
Balise XML de résultat
Explication
<SetDnssecResponse></SetDnssecResponse>le nœud racine de la réponse
<SetDnssecHeader></SetDnssecHeader>Définir l'en-tête Dnssec
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration de Dnssec

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnssecResponse>
  <SetDnssecHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnssecHeader>
  <SetDnssecContent/>
</SetDnssecResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_dnssec&domain_name=domain-haha1.com&flags=257&public_key=123&algorithm=1
Réponse (format JSON)
{
  "SetDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande Clear Dnssec

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande Clear Dnssec effacera le DNSSEC du domaine. Cette commande est disponible uniquement aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête Clear Dnssec
Explication
domain_nameLe nom de domaine pour lequel vous devez effacer le DNSSEC

Exemple Clear Dnssec

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<ClearDnssecResponse>
  <ClearDnssecHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ClearDnssecHeader>
</ClearDnssecResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=clear_dnssec&domain_name=domain-haha1.com
Réponse (format JSON)
{
  "ClearDnssecResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de définition de redirection e-mail

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set email forward, les paramètres suivants doivent être inclus :

Définir le paramètre de requête de redirection d'e-mail
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
forward_typeType de redirection, il peut être "donot" : Ne pas rediriger les e-mails, "mx" : Livrer les e-mails à un autre hôte de messagerie (enregistrement MX), "forward" : Livrer les e-mails à un autre hôte de messagerie
username0 - username9Nom d'utilisateur, utilisé uniquement quand "forward_type" est "forward"
exist_email0 - exist_email9Adresse e-mail existante, utilisée uniquement lorsque "forward_type" est "forward"
mx_host0 - mx_host2Hôte de messagerie, utilisé uniquement lorsque "forward_type" est "mx"
mx_distance0 - mx_distance2Distance0 est la priorité la plus élevée, à utiliser uniquement lorsque "forward_type" est "mx"
Balise XML de résultat
Explication
<SetEmailForwardingResponse></SetEmailForwardingResponse>Nœud racine du document XML de réponse
<SetEmailForwardingHeader></SetEmailForwardingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de Set Email Forward

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Réponse (format XML)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_email_forward&domain=testdomain.com&forward_type=forward&username0=testusername&[email protected]
Réponse (format JSON)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Clear Domain Setting

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set clear domain setting, les paramètres suivants doivent être inclus:

Paramètre de requête de définition/effacement des paramètres de domaine
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
serviceLe service que vous souhaitez effacer, il peut être "forward", "stealth", "email_forwarding", "dns", "dnssec" et "nameservers"
Balise XML de résultat
Explication
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nœud racine du document XML de réponse
<SetClearDomainSettingHeader></SetClearDomainSettingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du paramètre Clear Domain

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Réponse (format XML)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Réponse (format JSON)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Définir le dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir le dossier
Explication
domainLe nom de domaine à mettre à jour, seulement 1 domaine peut être défini par requête
folderLe nom du dossier dans lequel vous souhaitez déplacer votre domaine. Utilisez "Default" comme nom de dossier si vous souhaitez déplacer le domaine vers le dossier par défaut. Le nom du dossier est sensible à la casse. Par exemple, "Folder1" et "folder1" sont deux noms de dossier différents.
folder_id (optional)L'ID du dossier vers lequel vous souhaitez déplacer votre domaine
Balise XML de résultat
Explication
<SetFolderResponse></SetFolderResponse>Balise de la réponse de définition de dossier, c'est le nœud racine du document XML de réponse
<SetFolderHeader></SetFolderHeader>Définir l'en-tête du dossier
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de Set Folder

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
Réponse (format XML)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder&domain=domian1.com&folder=folder1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder&domain=domian1.com&folder=folder1
Réponse (format JSON)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition de note

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set note, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir une note
Explication
domainLe domaine que vous souhaitez définir, un seul domaine peut être défini par requête
noteLa note que vous souhaitez définir pour le domaine, peut être null
Balise XML de résultat
Explication
<SetNoteResponse></SetNoteResponse>Nœud racine du document XML de réponse
<SetNoteHeader></SetNoteHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de note

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Réponse (format XML)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_note&domain=domain1.com&note=Do not modify any information
Réponse (format JSON)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Définir l'option de renouvellement

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set renew option, les paramètres suivants doivent être inclus:

Définir le paramètre de requête de l'option de renouvellement
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
renew_optionCela peut être "donot", "auto", "reset"
Balise XML de résultat
Explication
<SetRenewOptionResponse></SetRenewOptionResponse>Nœud racine du document XML de réponse
<SetRenewOptionHeader></SetRenewOptionHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de l'option de renouvellement

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_renew_option&domain=domain1.com&renew_option=auto
Réponse (format JSON)
{
  "SetRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande Définir la confidentialité

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set privacy, les paramètres suivants doivent être inclus:

Paramètre de requête Set Privacy
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
optionLe statut de confidentialité du domaine que vous souhaitez définir peut être "full", "partial" ou "off"
whois_privacy_optionLe statut de confidentialité whois du domaine que vous voulez définir, il peut être "yes" ou "no"
Balise XML de résultat
Explication
<SetPrivacyResponse></SetPrivacyResponse>Nœud racine du document XML de réponse
<SetPrivacyHeader></SetPrivacyHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de la confidentialité

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Réponse (format XML)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_privacy&domain=domain1.com&whois_privacy_option=yes&option=off
Réponse (format JSON)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Prix des TLD

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette fonctionnalité n'est disponible qu'au format XML et JSON :

Paramètre de requête des prix des TLD
Explication
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est Api Default Currency du paramètre de compte
count_per_page (optional)Combien d'entités sont affichées par page
page_index (optional)Quelles entités de page voulez-vous afficher
sort (optional)Veuillez sélectionner l'une des options suivantes comme valeur du paramètre de tri :
* Si vous ne l'avez pas sélectionné, nous utiliserons le tri par défaut.
1) RankAsc (Par défaut)
2) RankDesc
3) Nom croissant
4) Nom décroissant
5) VentesAsc
6) SalesDesc
7) LaunchDateAsc
8) Description de la date de lancement
9) CountAsc
10) CountDesc
11) RegistryAsc
12) Description du registre
Balise XML de résultat
Explication
<TldPriceResponse></TldPriceResponse>Nœud racine du document XML de réponse
<TldPriceResponseHeader></TldPriceResponseHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<TldPriceContent></TldPriceContent>Contenu de la réponse
<TldContent></TldContent>Infos TLD
<Tld></Tld>Domaines de premier niveau
<Usage></Usage>Utilisation du TLD
<Price></Price>Informations sur le prix de ce TLD. Contient des sous-balises : : Unité de prix : Prix de l'enregistrement : Prix du renouvellement : Prix du transfert
<Privacy></Privacy>Si ce tld prend en charge la confidentialité whois
<GracePeriod></GracePeriod>Infos sur la période de grâce de ce TLD. Contient des sous-tags : : Unité d'informations sur la période de grâce : Période de grâce de renouvellement : Supprimer la période de grâce
<IDN></IDN>Si ce TLD prend en charge les noms de domaine internationalisés
<Restrictions></Restrictions>Nom de domaine

Exemple de prix des TLD

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=tld_price&currency=USD
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=tld_price&currency=USD
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
  <TldPriceResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <PriceLevel>Regular Pricing</PriceLevel>
    <Currency>USD</Currency>
  </TldPriceResponseHeader>
  <TldPriceContent>
    <TldContent>
      <Tld>com</Tld>
      <Usage>General</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>15.00</Register>
        <Renew>15.00</Renew>
        <Transfer>15.00</Transfer>
        <Restore>10.00</Restore>
      </Price>
      <Privacy>10.00</Privacy>
      <GracePeriod>
        <Unit>10.00</Unit>
        <Renew>10.00</Renew>
        <Delete>30</Delete>
        <Restore>YES</Restore>
      </GracePeriod>
      <IDN>YES</IDN>
      <Restrictions>--</Restrictions>
      <OnSale>Yes</OnSale>
      <maxDuration>10</maxDuration>
      <minDuration>1</minDuration>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=tld_price&currency=USD
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=tld_price&currency=USD
Réponse (format JSON)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": "com",
        "Usage": "General",
        "IDN": "YES",
        "Restrictions": "--",
        "OnSale": "Yes",
        "Privacy": "10.00",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "15.00",
          "Renew": "15.00",
          "Transfer": "15.00",
          "Restore": "10.00"
        },
        "GracePeriod": {
          "Unit": "10.00",
          "Renew": "10.00",
          "Delete": "30",
          "Restore": "YES"
        },
        "maxDuration": 10,
        "minDuration": 1
      }
    ]
  }
}
 

Commande de liste des domaines

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette fonctionnalité n'est disponible qu'au format XML et JSON :

Paramètre de requête de liste de domaines
Explication
customer_id (optional)Filtrer les données par ID client (seuls les revendeurs peuvent utiliser ce paramètre)
count_per_page (optional)Combien d'entités sont affichées par page
page_index (optional)Quelles entités de page voulez-vous afficher
sort (optional)Veuillez sélectionner l'une des options suivantes comme valeur du paramètre de tri :
* Si vous ne l'avez pas sélectionné, nous utiliserons le tri par défaut.
1) CountAsc (Par défaut)
2) CountDesc
3) Nom croissant
4) Nom décroissant
Balise XML de résultat
Explication
<ListDomainInfoResponse></ListDomainInfoResponse>Nœud racine du document XML de réponse
<ListDomainInfoHeader></ListDomainInfoHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<ListDomainInfoContent></ListDomainInfoContent>Contenu de la réponse
<DomainInfoList></DomainInfoList>Liste des informations de domaine
<DomainInfo></DomainInfo>Informations sur le domaine
<Domain></Domain>Domaine
<Name></Name>Nom de domaine
<Expiration></Expiration>Date d'expiration du domaine en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<Registration></Registration>Date d'enregistrement du domaine en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<NameServerSettings></NameServerSettings>Paramètres du serveur de noms
<Type></Type>Type de configuration des serveurs de noms
<WithAds></WithAds>Avec ou sans publicités
<Whois></Whois>Informations Whois
<Registrant></Registrant>Informations sur le titulaire
<ContactId></ContactId>ID du contact
<Admin></Admin>Informations d'administrateur
<Technical></Technical>Informations techniques
<Billing></Billing>Informations de facturation
<Locked></Locked>Verrouillé ou non
<Disabled></Disabled>Statut d'activation
<Hold></Hold>Statut de blocage Client/Registrar
<Privacy></Privacy>Statut de confidentialité
<isForSale></isForSale>Statut de vente
<RenewOption></RenewOption>Option de renouvellement
<Note></Note>Note
<Folder></Folder>Informations sur le dossier
<FolderId></FolderId>ID du dossier
<FolderName></FolderName>Nom du dossier

Exemple de liste de domaines

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_domain
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_domain
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
          <Status>active</Status>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
          <Status>moved</Status>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=list_domain
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_domain
Réponse (format JSON)
{
  "ListDomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "MainDomains": [
      {
        "Name": "domain-exp140.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "0"
          },
          "Admin": {
            "ContactId": "0"
          },
          "Technical": {
            "ContactId": "0"
          },
          "Billing": {
            "ContactId": "0"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        },
        "Status": "active"
      },
      {
        "Name": "domain-exp141.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "1"
          },
          "Admin": {
            "ContactId": "2"
          },
          "Technical": {
            "ContactId": "3"
          },
          "Billing": {
            "ContactId": "4"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        },
        "Status": "moved"
      }
    ]
  }
}
 

Commande de verrouillage de domaine

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande lock domain, les paramètres suivants doivent être inclus :

Paramètre de requête de verrouillage de domaine
Explication
domainLe nom de domaine que vous souhaitez verrouiller, un seul domaine peut être saisi par requête
Balise XML de résultat
Explication
<LockDomainResponse></LockDomainResponse>Nœud racine du document XML de réponsedocument XML
<LockDomainHeader></LockDomainHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de verrouillage de domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=lock_domain&domain=domain4.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
Réponse (format XML)
<LockDomainResponse>
   <LockDomainHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </LockDomainHeader>
</LockDomainResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=lock_domain&domain=domain4.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=lock_domain&domain=domain4.com
Réponse (format JSON)
{
   "LockDomainResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de recherche de suggestions

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande de recherche de suggestions achètera le nom de domaine spécifié. Cette commande est uniquement disponible aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête de recherche de suggestions
Explication
domainLe domaine que vous souhaitez rechercher, 1 seul domaine peut être saisi par requête
tlds (optional)Les TLD uniquement contenus dans le résultat de recherche
Balise XML de résultat
Explication
<SuggestionSearchResponse></SuggestionSearchResponse>Balise de la réponse de recherche de suggestions, c'est le nœud racine du document XML de réponse
<SuggestionSearchHeader></SuggestionSearchHeader>En-tête de recherche de suggestions
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de recherche de suggestions

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SuggestionSearchResponse>
  <SuggestionSearchHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SuggestionSearchHeader>
  <SuggestionSearchContent>
    <SuggestionSearch>
      <Domain>test1.com</Domain>
      <Domain>test2.com</Domain>
      <Domain>test3.net</Domain>
      <Domain>test4.net</Domain>
    </SuggestionSearch>
  </SuggestionSearchContent>
</SuggestionSearchResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=suggestion_search&domain=domain.com&action=com,net
Réponse (format JSON)
{
  "SuggestionSearchResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Domains": [
      "test1.com",
      "test2.com",
      "test3.net",
      "test4.net"
    ]
  }
}
 

Commande d'annulation de transfert

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

La commande vous permet d'annuler un élément de transfert dans la commande. Si vous appelez la commande d'annulation de transfert, les paramètres suivants doivent être inclus :

Paramètre de demande d'annulation de transfert
Explication
domainLe nom de domaine pour lequel vous souhaitez annuler le transfert, un seul domaine peut être saisi par requête
order_idL'ID de commande de transfert, vous pouvez l'obtenir à partir d'une autre API get_transfer_status.
Balise XML de résultat
Explication
<CancelTransferResponse></CancelTransferResponse>Nœud racine du document XML de réponsedocument XML
<CancelTransferHeader></CancelTransferHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple d'annulation de transfert

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=cancel_transfer&domain=domain4.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<CancelTransferResponse>
  <CancelTransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CancelTransferHeader>
</CancelTransferResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=cancel_transfer&domain=domain4.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=cancel_transfer&domain=domain4.com
Réponse (format JSON)
{
  "CancelTransferResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande pour obtenir le statut du transfert

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande get transfer status, les paramètres suivants doivent être inclus :

Paramètre de requête de statut de transfert
Explication
domainLe nom de domaine pour lequel vous souhaitez obtenir le statut de transfert, un seul domaine peut être saisi par requête
transfer_typeLe type de transfert pour lequel vous souhaitez obtenir le statut (transfert entrant ou transfert sortant)
Balise XML de résultat
Explication
<GetTransferStatusResponse></GetTransferStatusResponse>Nœud racine du document XML de réponsedocument XML
<GetTransferStatusHeader></GetTransferStatusHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetTransferStatusContent></GetTransferStatusContent>Contenu de la réponse
<TransferList></TransferList>Liste des transferts
<Transfer></Transfer>Informations de transfert
<OrderId></OrderId>L'ID de la commande
<TransferStatus></TransferStatus>Le statut de transfert du domaine. Si vous obtenez 'none' ou 'approved', vous pouvez annuler le transfert. Si vous obtenez 'waiting', cela signifie que le transfert a déjà commencé. Si vous obtenez 'auth code needed', cela signifie un mauvais code d'authentification, vous pouvez utiliser une autre api SET_TRANSFER_AUTH pour resoumettre le code d'authentification. Il y a aussi d'autres statuts, nous vous enverrons un e-mail ou cela devra être vérifié par nos ingénieurs.

Exemple de récupération du statut de transfert

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
  <GetTransferStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetTransferStatusHeader>
  <GetTransferStatusContent>
    <TransferList>
      <Transfer>
        <OrderId>testorderid</OrderId>
        <TransferStatus>teststatus</TransferStatus>
      </Transfer>
      <Transfer>
        <OrderId>testorderid2</OrderId>
        <TransferStatus>teststatus2</TransferStatus>
      </Transfer>
    </TransferList>
  </GetTransferStatusContent>
</GetTransferStatusResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_status&domain=domian1.com&transfer_type=in
Réponse (format JSON)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

Définir le code d'authentification de transfert pour la commande de transfert

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

La commande qui vous permet de mettre à jour le code d'autorisation pour traiter les ordres de transfert. Si vous appelez la commande set transfer auth code, les paramètres suivants doivent être inclus :

Définir le paramètre de requête du code d'autorisation de transfert
Explication
domainLe nom de domaine pour lequel vous mettez à jour l'autorisation de transfert, un seul domaine peut être saisi par requête
auth_codeL'auth_code que vous souhaitez soumettre à nouveau
order_idL'ID de commande de transfert, vous pouvez l'obtenir à partir d'une autre API get_transfer_status.
Balise XML de résultat
Explication
<GetTransferStatusResponse></GetTransferStatusResponse>Nœud racine du document XML de réponsedocument XML
<GetTransferStatusHeader></GetTransferStatusHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du code d'autorisation de transfert

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Réponse (format XML)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Réponse (format JSON)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Authorize Transfer Away

Prise en charge du multi-thread
Prise en charge de l'API Sandbox
Paramètre de requête d'autorisation de transfert sortant
Explication
domainLe nom de domaine pour lequel vous souhaitez autoriser le transfert sortant, un seul domaine peut être saisi par requête
order_idL'order_id Dynadot du domaine que vous voulez transférer ailleurs
authorizePour autoriser le transfert sortant, définissez-le sur "approve". Pour refuser le transfert sortant, définissez-le sur "deny".
Balise XML de résultat
Explication
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>Nœud racine du document XML de réponsedocument XML
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<Result></Result>Le résultat de l'autorisation de transfert sortant

Exemple d'autorisation de transfert sortant

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<AuthorizeTransferAwayResponse>
  <AuthorizeTransferAwayHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <Result>away_approved</Result>
  </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=authorize_transfer_away&domain=domain.com&authorize=approve&order_id=123
Réponse (format JSON)
{
  "AuthorizeTransferAwayResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Result": "away_approved"
  }
}
 

Commande d'obtention du code d'autorisation de transfert

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Vous devez déverrouiller votre domaine et votre compte avant de demander le code d'authentification.

Paramètre de requête pour obtenir le code d'autorisation de transfert
Explication
domainLe nom de domaine pour lequel vous voulez obtenir le code d'autorisation de transfert, un seul domaine peut être saisi par requête
new_code (optional)Générer un nouveau code d'autorisation de transfert
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Si vous souhaitez déverrouiller le domaine pour le transfert, définissez-le sur "1". Si la demande est traitée avec succès, le domaine sera déverrouillé.
Balise XML de résultat
Explication
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Nœud racine du document XML de réponsedocument XML
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<AuthCode></AuthCode>Le code d'authentification est utilisé pour démarrer un transfert de domaine.

Exemple d'obtention du code d'autorisation de transfert

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferAuthCodeResponse>
  <GetTransferAuthCodeHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <AuthCode>testauthcode</AuthCode>
  </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Réponse (format JSON)
{
  "GetTransferAuthCodeResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AuthCode": "testauthcode"
  }
}
 

Commande Get Domain Push Request

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande Get Domain Push Request permettra d'obtenir la demande de push de domaine. Cette commande n'est disponible qu'aux formats XML et JSON.

Paramètre de requête de Get Domain Push Request
Explication
N/A Aucun paramètre supplémentaire nécessaire
Balise XML de résultat
Explication
<GetDomainPushRequestResponse></GetDomainPushRequestResponse>le nœud racine de la réponse
<GetDomainPushRequestHeader></GetDomainPushRequestHeader>En-tête de la requête Get Domain Push
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetDomainPushRequestContent></GetDomainPushRequestContent>contenu de la réponse
<PushDomain></PushDomain>Pousser le domaine
<PushDomainName></PushDomainName>Pousser le nom de domaine

Exemple de requête pour obtenir un push de domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_domain_push_request
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_domain_push_request
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetDomainPushRequestResponse>
  <GetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDomainPushRequestHeader>
  <GetDomainPushRequestContent>
    <PushDomain>
      <PushDomainName>haha.com</PushDomainName>
    </PushDomain>
    <PushDomain>
      <PushDomainName>haha1.com</PushDomainName>
    </PushDomain>
  </GetDomainPushRequestContent>
</GetDomainPushRequestResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_domain_push_request
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_domain_push_request
Réponse (format JSON)
{
  "GetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "pushDomainName": "[haha.com,haha1.com]"
  }
}
 

Commande Set Domain Push Request

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

L'appel de la commande Set Domain Push Request définira la demande de push de domaine. Cette commande est uniquement disponible aux formats XML et JSON.Si vous appelez cette commande, les paramètres suivants doivent être inclus:

Paramètre de requête de la demande de push de domaine
Explication
domainsLe nom de domaine de la commande à traiter
actionL'action de la commande à traiter, vous pouvez choisir "accept" ou "decline"
Balise XML de résultat
Explication
<SetDomainPushRequestResponse></SetDomainPushRequestResponse>le nœud racine de la réponse
<SetDomainPushRequestHeader></SetDomainPushRequestHeader>En-tête de requête Set Domain Push
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de requête de push de domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDomainPushRequestResponse>
  <SetDomainPushRequestHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetDomainPushRequestHeader>
  <SetDomainPushRequestContent/>
</SetDomainPushRequestResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_domain_push_request&domains=domain-haha1.com,domain-haha2.com,domain-haha3.com&action=accept
Réponse (format JSON)
{
  "SetDomainPushRequestResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de création d'audit CN

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

La commande vous permet de créer un audit CN pour un contact. Si vous appelez la commande create cn audit, les paramètres suivants doivent être inclus :

Paramètre de requête de création d'audit CN
Explication
contact_idL'ID de l'enregistrement de contact pour lequel vous souhaitez démarrer l'audit, un seul ID de contact peut être saisi par requête
contact_typeLe type de contact peut être "Individual" ou "Enterprise"
individual_id_typeType de pièce d'identité de personne physique, les valeurs attendues (description de la valeur) sont :
JGZ (carte d'identité d'officier de la République populaire de Chine)
SFZ (carte d'identité de la République populaire de Chine)
HZ (Passeport)
GAJMTX (Permis d'entrée et de sortie pour voyager vers et depuis Hong Kong et Macao)
TWJMTX (Titres de voyage pour les résidents de Taïwan pour entrer ou quitter le continent)
WJLSFZ (Carte d'identité de résident permanent étranger de la République populaire de Chine)
GAJZZ (Permis de résidence pour Hong Kong, Macao)
TWJZZ (permis de séjour pour les résidents de Taïwan)
QT (Autres)
individual_license_idLe numéro de licence de la pièce d'identité de la personne physique
individual_urlDocument de pièce d'identité de personne physique. L'URL du fichier sur le serveur. Seuls jpg, gif, png, jpeg sont autorisés
enterprise_id_type (Mandatory when contact type is "Enterprise")Type d'ID d'entreprise, les valeurs attendues (description de la valeur) sont :
ORG (Certificat de code d'organisation)
YYZZ (Licence commerciale)
TYDM (Certificat pour le code unifié de crédit social)
BDDM (Code de désignation militaire)
JDDWFW (Licence de service externe payant militaire)
SYDWFR (Certificat de personne morale d'établissement public)
WGCZJG (Formulaire d'enregistrement des bureaux de représentation résidents des entreprises étrangères)
SHTTFR (certificat d'enregistrement de personne morale d'organisation sociale)
ZJCS (Certificat d'enregistrement de site d'activités religieuses)
MBFQY (Certificat d'enregistrement d'entité privée non commerciale)
JJHFR (Certificat d'enregistrement de personne morale de fonds)
LSZY (Licence d'exercice d'un cabinet d'avocats)
WGZHWH (Certificat d'enregistrement de centre culturel étranger en Chine)
WLCZJG (Certificat d'enregistrement et d'approbation du bureau de représentation résident des services de tourisme d'un gouvernement étranger)
SFJD (Licence d'expertise judiciaire)
JWJG (Certificat d'organisation étrangère)
SHFWJG (Certificat d'enregistrement d'agence de service social)
MBXXBX (Permis d'école privée)
YLJGZY (Licence d'exercice des établissements médicaux)
GZJGZY (Licence d'exercice d'une organisation notariale)
BJWSXX (Permis de l'École de Pékin pour les enfants du personnel des ambassades étrangères en Chine)
QTTYDM (Autres - Certificat pour le code unifié de crédit social)
QT (Autres)
enterprise_license_id (Mandatory when contact type is "Enterprise")Le numéro de licence du document d'entreprise
enterprise_url (Mandatory when contact type is "Enterprise")Document de licence d'entreprise. L'URL du fichier sur le serveur. Seuls les formats jpg, gif, png, jpeg sont autorisés
Balise XML de résultat
Explication
<CreateCnAuditResponse></CreateCnAuditResponse>Nœud racine du document XML de réponse
<CreateCnAuditHeader></CreateCnAuditHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de Create Cn Audit

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
</CreateCnAuditResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Réponse (format JSON)
{
  "CreateCnAuditResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de récupération du statut d'audit Cn

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande get cn audit status, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir le statut d'audit Cn
Explication
contact_idL'ID de l'enregistrement de contact pour lequel vous souhaitez obtenir le statut d'audit, un seul contactId peut être saisi par requête
gtldSi vous consultez le résultat d'audit du cnnic-gtld, définissez ce paramètre sur 1
Balise XML de résultat
Explication
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>Nœud racine du document XML de réponsedocument XML
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<CnAuditStatus></CnAuditStatus>le statut d'audit de l'enregistrement d'audit cnnic. Vous pouvez obtenir 'en cours' ou 'en attente de cnnic' ou 'échec'. En cas d'échec, nous vous enverrons un email.
<FailedReason></FailedReason>Si l'audit ne passe pas, la raison de l'échec sera affichée

Exemple de récupération du statut d'audit Cn

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_cn_audit_status&contact_id=testcontactid
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_cn_audit_status&contact_id=testcontactid
Réponse (format JSON)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

Commande de création de contact

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de création de contact, les paramètres suivants doivent être inclus :

Paramètre de requête de création de contact
Explication
organization (optional)Les informations de l'organisation
nameTerme
emailEmail
phonenumNuméro de téléphone
phoneccIndicatif téléphonique du pays
faxnum (optional)Numéro de fax
faxcc (optional)Indicatif pays du fax
address1Adresse1
address2 (optional)Adresse 2
cityVille
state (optional)État
zipCode postal
countryPays
Balise XML de résultat
Explication
<CreateContactResponse></CreateContactResponse>Nœud racine du document XML de réponse
<CreateContactHeader></CreateContactHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<CreateContactContent></CreateContactContent>ID du nouveau contact, utilisé uniquement lorsque le paramètre status est "success"

Exemple de création de contact

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Réponse (format XML)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Réponse (format JSON)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

Commande de modification de contact

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de modification de contact, les paramètres suivants doivent être inclus :

Paramètre de requête de modification de contact
Explication
contact_idL'ID du contact que vous souhaitez modifier
organization (optional)Les informations de l'organisation
nameTerme
emailEmail
phonenumNuméro de téléphone
phoneccIndicatif téléphonique du pays
faxnum (optional)Numéro de fax
faxcc (optional)Indicatif pays du fax
address1Adresse 1
address2 (optional)Adresse 2
cityVille
stateÉtat
zipCode postal
countryPays
Balise XML de résultat
Explication
<EditContactResponse></EditContactResponse>Nœud racine du document XML de réponse
<EditContactHeader></EditContactHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<EditContactContent></EditContactContent>Contenu de la réponse
<ContactId></ContactId>ID du contact

Exemple de modification de contact

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Réponse (format JSON)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Réponse (format CSV)
ok,

success,
,
 

Commande de suppression de contact

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de suppression de contact, les paramètres suivants doivent être inclus:

Paramètre de requête de suppression de contact
Explication
contact_idL'ID du contact que vous souhaitez supprimer, assurez-vous qu'ils sont séparés par des virgules
Balise XML de résultat
Explication
<DeleteContactResponse></DeleteContactResponse>Nœud racine du document XML de réponse
<DeleteContactHeader></DeleteContactHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de suppression de contact

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_contact&contact_id=0
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_contact&contact_id=0
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteContactHeader>
</DeleteContactResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_contact&contact_id=0
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_contact&contact_id=0
Réponse (format JSON)
{
  "DeleteContactResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de liste de contacts

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête de liste de contacts
Explication
N/AAucun paramètre supplémentaire nécessaire
Balise XML de résultat
Explication
<ContactListResponse></ContactListResponse>Nœud racine du document XML de réponse
<ContactListHeader></ContactListHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<ContactListContent></ContactListContent>Contenu de la réponse
<ContactList></ContactList>Liste de contacts
<Contact></Contact>Coordonnées
<ContactId></ContactId>ID de contact
<Organization></Organization>Organisation du contact
<Name></Name>Terme
<Email></Email>Email
<PhoneCc></PhoneCc>Indicatif téléphonique du pays
<PhoneNum></PhoneNum>Numéro de téléphone
<FaxCc></FaxCc>Indicatif pays du fax
<FaxNum></FaxNum>Numéro de fax
<Address1></Address1>Adresse 1
<Address2></Address2>Adresse 2
<City></City>Ville
<State></State>État
<ZipCode></ZipCode>Code postal
<Country></Country>Pays
<GtldVerified></GtldVerified>Statut de vérification gTLD

Exemple de liste de contacts

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=contact_list
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=contact_list
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack tester</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>test street</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=contact_list
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=contact_list
Réponse (format JSON)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack tester",
        "Email": "",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "test street",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}
 

Commande de récupération du contact

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête d'obtention de contact
Explication
contact_idid du contact
Balise XML de résultat
Explication
<GetContactResponse></GetContactResponse>Nœud racine du document XML de réponse
<GetContactHeader></GetContactHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetContactContent></GetContactContent>Contenu de la réponse
<Contact></Contact>Coordonnées
<ContactId></ContactId>ID de contact
<Organization></Organization>Organisation du contact
<Name></Name>Terme
<Email></Email>Email
<PhoneCc></PhoneCc>Indicatif téléphonique du pays
<PhoneNum></PhoneNum>Numéro de téléphone
<FaxCc></FaxCc>Indicatif pays du fax
<FaxNum></FaxNum>Numéro de fax
<Address1></Address1>Adresse 1
<Address2></Address2>Adresse 2
<City></City>Ville
<State></State>État
<ZipCode></ZipCode>Code postal
<Country></Country>Pays
<GtldVerified></GtldVerified>Statut de vérification gTLD

Exemple de récupération de contact

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_contact&contact_id=10000
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_contact&contact_id=10000
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_contact&contact_id=10000
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_contact&contact_id=10000
Réponse (format JSON)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

Commande de définition des paramètres de contact UE

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de configuration des paramètres de contact UE, les paramètres suivants doivent être inclus :

Paramètre de requête Set Contact EU Setting
Explication
contact_idL'ID du contact que vous souhaitez modifier
country_of_citizenshipDoit être un État membre de l'UE, les codes pays des États membres incluent :
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
Balise XML de résultat
Explication
<SetContactEUSettingResponse></SetContactEUSettingResponse>Nœud racine du document XML de réponse
<SetContactEUSettingHeader></SetContactEUSettingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Contenu de la réponse
<ContactId></ContactId>ID du contact

Exemple de réglage des paramètres UE du contact

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Réponse (format JSON)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

Commande de définition du paramètre LV du contact

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Lors de l'appel de la commande set contact lv setting, les paramètres suivants doivent être inclus :

Définir le paramètre de requête du réglage LV du contact
Explication
contact_idL'ID du contact que vous souhaitez modifier
registration_number- Pour les particuliers, veuillez saisir le numéro d'identification letton.
- Pour les entreprises et autres entités légales, veuillez saisir le numéro d'enregistrement délivré par le Registre des entreprises letton.
vat_number (optional)Numéro de TVA pour les entités juridiques étrangères enregistrées dans les pays de l'Union européenne (cela inclut également les entreprises lettones)
Balise XML de résultat
Explication
<SetContactLvSettingResponse></SetContactLvSettingResponse>Nœud racine du document XML de réponse
<SetContactLvSettingHeader></SetContactLvSettingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Contenu de la réponse
<ContactId></ContactId>ID du contact

Exemple de paramètre de contact Lv

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Réponse (format JSON)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}

Exemple de configuration du paramètre LV du contact

Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number
Réponse (format CSV)
ok,success,0
 

Commande de définition du paramètre LT du contact

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du paramètre LT du contact, les paramètres suivants doivent être inclus :

Paramètre de requête pour la définition du paramètre LT du contact
Explication
contact_idL'ID du contact que vous souhaitez modifier
organization_codeVous ne pouvez définir le code d'organisation du contact qu'après avoir défini l'organisation du contact.
Balise XML de résultat
Explication
<SetContactLtSettingResponse></SetContactLtSettingResponse>Nœud racine du document XML de réponse
<SetContactLtSettingHeader></SetContactLtSettingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<SetContactLtSettingContent></SetContactLtSettingContent>Contenu de la réponse
<ContactId></ContactId>ID du contact

Exemple de définition du paramètre LT du contact

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLtSettingResponse>
  <SetContactLtSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLtSettingHeader>
  <SetContactLtSettingContent>
    <ContactId>0</ContactId>
  </SetContactLtSettingContent>
</SetContactLtSettingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_contact_lt_setting&contact_id=0&organization_code=testing_organization_code
Réponse (format JSON)
{
  "SetContactLtSettingResponse": {
    "ResponseCode:": "0",
    "Status": "Success",
    "SetContactLtSettingContent": {
      "ContactId": "0"
    }
  }
}
 

Commande d'obtention des serveurs de noms

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande get name server, les paramètres suivants doivent être inclus:

Paramètre de la requête Get Name Server
Explication
domainLe domaine dont vous souhaitez obtenir les informations de serveur de noms ; les informations de serveur de noms d'un seul domaine peuvent être récupérées par requête.
Balise XML de résultat
Explication
<GetNsResponse></GetNsResponse>Nœud racine du document XML de réponse
<GetNsHeader></GetNsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<NsContent></NsContent>Contenu de la réponse
<Host></Host>Nom d'hôte du serveur
<NsName></NsName>Nom du serveur

Exemple de récupération des NS

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_ns&domain=mydomain.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_ns&domain=mydomain.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_ns&domain=mydomain.com
Réponse (format JSON)
{
  "GetNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "NsContent": {
      "Host0": "ns1.mydomain.com",
      "Host1": "ns2.mydomain.com"
    }
  }
}
 

Commande d'ajout d'un serveur de noms

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande d'ajout de serveur de noms, les paramètres suivants doivent être inclus :

Paramètre de requête d'ajout de serveur de noms
Explication
hostLe nom d'hôte du serveur de noms que vous souhaitez ajouter
Balise XML de résultat
Explication
<AddNsResponse></AddNsResponse>Nœud racine du document XML de réponse
<AddNsHeader></AddNsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<AddNsContent></AddNsContent>Contenu de la réponse
<Server></Server>Serveur que vous avez configuré
<Host></Host>Nom d'hôte du nouveau serveur
<ServerId></ServerId>ID du nouveau serveur

Exemple d'ajout de NS

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_ns&host=ns1.mydomain.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_ns&host=ns1.mydomain.com
Réponse (format JSON)
{
  "AddNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AddNsContent": {
      "Server": {
        "Host": "ns1.mydomain.com",
        "ServerId": 0
      }
    }
  }
}
 

Commande d'enregistrement de serveur de noms

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande d'enregistrement de serveur de noms, les paramètres suivants doivent être inclus:

Paramètre de requête d'enregistrement de serveur de noms
Explication
hostLe nom d'hôte de votre propre serveur de noms
ipL'adresse IP de votre propre serveur de noms
Balise XML de résultat
Explication
<RegisterNsResponse></RegisterNsResponse>Nœud racine du document XML de réponse
<RegisterNsHeader></RegisterNsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<RegisterNsContent></RegisterNsContent>Contenu de la réponse
<Server></Server>Étiquette du serveur
<Host></Host>Nom d'hôte
<ServerId></ServerId>ID du serveur

Exemple d'enregistrement de serveur de noms

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Réponse (format XML)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=register_ns&host=domain1.com&ip=192.168.1.1
Réponse (format JSON)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

Commande de définition de l'IP du serveur de noms

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set name server IP, les paramètres suivants doivent être inclus:

Paramètre de requête de définition de l'IP du serveur de noms
Explication
server_idL'ID du serveur de noms que vous souhaitez définir
ip0 - ip9L'adresse IP que vous souhaitez définir pour le serveur de noms, 9 IP peuvent être définies par requête et doivent être séparées par des virgules
Balise XML de résultat
Explication
<SetNsIpResponse></SetNsIpResponse>Nœud racine du document XML de réponse
<SetNsIpHeader></SetNsIpHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de l'IP du serveur de noms

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Réponse (format XML)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Réponse (format JSON)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de suppression de serveur de noms

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de suppression de serveur de noms, les paramètres suivants doivent être inclus :

Paramètre de requête de suppression de serveur de noms
Explication
server_idL'ID des serveurs de noms que vous voulez supprimer, assurez-vous qu'ils sont séparés par des virgules
Balise XML de résultat
Explication
<DeleteNsResponse></DeleteNsResponse>Nœud racine du document XML de réponse
<DeleteNsHeader></DeleteNsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de suppression des Ns

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns&server_id=0
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns&server_id=0
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns&server_id=0
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns&server_id=0
Réponse (format JSON)
{
  "DeleteNsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de suppression du serveur de noms par domaine

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de suppression de serveur de noms par domaine, les paramètres suivants doivent être inclus:

Supprimer le serveur de noms via le paramètre de requête du domaine
Explication
server_domainNom du serveur de noms. ex: ns1.testnameserver.com
Balise XML de résultat
Explication
<DeleteNsResponse></DeleteNsResponse>Nœud racine du document XML de réponse
<DeleteNsHeader></DeleteNsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de suppression de serveur de noms par domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Réponse (format XML)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Réponse (format JSON)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de liste des serveurs

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête de la liste des serveurs
Explication
N/AAucun paramètre supplémentaire nécessaire
Balise XML de résultat
Explication
<ServerListResponse></ServerListResponse>Nœud racine du document XML de réponse
<ServerListHeader></ServerListHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<ServerListContent></ServerListContent>Contenu de la réponse
<NameServerList></NameServerList>Liste des serveurs de noms
<List></List>
<Server></Server>
<ServerId></ServerId>ID du serveur
<ServerName></ServerName>Nom du serveur
<ServerIp></ServerIp>IP du serveur

Exemple de liste de serveurs

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=server_list
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=server_list
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
          <ServerIp>1.1.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=server_list
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=server_list
Réponse (format JSON)
{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIps": [
          {
            "Ip": "192.168.1.1"
          },
          {
            "Ip": "1.1.1.1"
          }
        ]
      }
    ]
  }
}
 

Commande d'obtention des paramètres du serveur de noms de domaine

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande get domain nameservers settings, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir les paramètres du serveur de noms de domaine
Explication
domainLe domaine dont vous souhaitez obtenir le paramètre de serveur de noms ; un seul paramètre de serveur de noms de domaine peut être récupéré par requête.
Balise XML de résultat
Explication
<GetDnsResponse></GetDnsResponse>Nœud racine du document XML de réponse
<GetDnsHeader></GetDnsHeader>En-tête de réponse
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetDnsContent></GetDnsContent>Contenu de la réponse
<NameServerSettings></NameServerSettings>Paramètres des serveurs de noms du domaine
<Type></Type>Type de serveur de noms du domaine

Exemple de récupération des paramètres du serveur de noms de domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_dns&domain=mydomain.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_dns&domain=mydomain.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_dns&domain=mydomain.com
Réponse (format JSON)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

Commande d'informations de compte

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête d'informations sur le compte
Explication
N/AAucun paramètre supplémentaire nécessaire
Balise XML de résultat
Explication
<AccountInfoResponse></AccountInfoResponse>Nœud racine du document XML de réponse
<AccountInfoHeader></AccountInfoHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<AccountInfoContent></AccountInfoContent>Contenu de la réponse
<AccountInfo></AccountInfo>Informations sur le compte
<Username></Username>Nom d'utilisateur
<ForumName></ForumName>Nom du forum
<Contact></Contact>Coordonnées
<Organization></Organization>Organisation
<Organization></Organization>En-tête de réponse
<Name></Name>Votre nom
<Email></Email>Email
<PhoneCc></PhoneCc>Indicatif téléphonique du pays
<PhoneNum></PhoneNum>Numéro de téléphone
<Address1></Address1>Adresse 1
<Address2></Address2>Adresse 2
<City></City>Ville
<State></State>État
<ZipCode></ZipCode>Code postal
<Country></Country>Pays
<CustomerSince></CustomerSince>Client depuis
<AccountLock></AccountLock>Verrouillage du compte
<TotalSpending></TotalSpending>Total des dépenses
<PriceLevel></PriceLevel>Niveau de prix
<AccountBalance></AccountBalance>Solde du compte
<CustomTimeZone></CustomTimeZone>Fuseau horaire personnalisé
<DefaultSettings></DefaultSettings>Paramètres par défaut
<DefaultWhois></DefaultWhois>Whois par défaut
<DefaultRegistrant></DefaultRegistrant>Titulaire par défaut
<ContactId></ContactId>ID de contact
<DefaultAdmin></DefaultAdmin>Administrateur par défaut
<DefaultTechnical></DefaultTechnical>Technique par défaut
<DefaultBilling></DefaultBilling>Facturation par défaut
<Type></Type>Type de serveur de noms
<WithAds></WithAds>Avec ou sans publicités

Exemple d'informations de compte

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=account_info
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=account_info
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <AvatarUrl>test avatar url</AvatarUrl>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email></Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=account_info
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=account_info
Réponse (format JSON)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "AvatarUrl": "test avatar url",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}
 

Commande d'obtention du solde du compte

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête d'obtention du solde du compte
Explication
N/AAucun paramètre supplémentaire nécessaire
Balise XML de résultat
Explication
<GetAccountBalanceResponse></GetAccountBalanceResponse>Nœud racine du document XML de réponsedocument XML
<GetAccountBalanceHeader></GetAccountBalanceHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Contenu de la réponse
<Balance></Balance>Solde du compte

Exemple d'obtention du solde du compte

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_account_balance
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_account_balance
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_account_balance
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_account_balance
Réponse (format JSON)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

Définir le Whois par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set default Whois, les paramètres suivants doivent être inclus :

Paramètre de requête de définition du Whois par défaut
Explication
registrant_contactLes informations du titulaire du domaine
admin_contactLes informations de l'administrateur du domaine
technical_contactLes informations techniques du domaine
billing_contactLes informations de facturation du domaine
Balise XML de résultat
Explication
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Nœud racine du document XML de réponse
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du Whois par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Réponse (format XML)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Réponse (format JSON)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Name Servers

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition des serveurs de noms par défaut, les paramètres suivants doivent être inclus :

Paramètre de requête de définition des serveurs de noms par défaut
Explication
ns0 - ns12Les serveurs de noms que vous souhaitez définir
Balise XML de résultat
Explication
<SetDefaultNsResponse></SetDefaultNsResponse>Balise de la réponse de définition des serveurs de noms par défaut, c'est le nœud racine du document XML de réponse
<SetDefaultNsHeader></SetDefaultNsHeader>Balise de l'en-tête de définition des serveurs de noms par défaut
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<SetDefaultNsContent></SetDefaultNsContent>Balise du contenu de définition des serveurs de noms par défaut, elle n'est utilisée que lorsque le paramètre status est "success"
<Servers></Servers>Les informations des serveurs que vous avez définis
<Server></Server>Chaque serveur
<ServerName></ServerName>Nom du serveur
<ServerId></ServerId>ID du serveur

Exemple de définition des Ns par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultNsResponse>
  <SetDefaultNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultNsHeader>
  <SetDefaultNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetDefaultNsContent>
</SetDefaultNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Réponse (format JSON)
{
  "SetDefaultNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetDefaultNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

Commande de définition du parking par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du parking par défaut, les paramètres suivants doivent être inclus :

Définir le paramètre de requête de parking par défaut
Explication
with_ads (optional)Si vous ne voulez pas d'annonces tierces, vous pouvez utiliser ce paramètre avec "no", la valeur par défaut est "yes"
Balise XML de résultat
Explication
<SetDefaultParkingResponse></SetDefaultParkingResponse>Nœud racine du document XML de réponse
<SetDefaultParkingHeader></SetDefaultParkingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du parking par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
Réponse (format XML)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_parking&folder_id=0&with_ads=no
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_parking&folder_id=0&with_ads=no
Réponse (format JSON)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Default Forwarding

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du transfert par défaut, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir la redirection par défaut
Explication
forward_urlL'URL vers laquelle vous voulez que votre domaine redirige. Veuillez noter que le paramètre doit être encodé afin que l'appel API soit interprété correctement.
is_temp (optional)Statut de redirection souhaité pour votre domaine, la valeur par défaut est "temporary", si vous souhaitez rediriger définitivement, utilisez ce paramètre avec "no"
Balise XML de résultat
Explication
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Nœud racine du document XML de réponse
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de la redirection par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Réponse (format XML)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_forwarding&forward_url=http://mydomain.com
Réponse (format JSON)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Définir le mode furtif par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set default stealth, les paramètres suivants doivent être inclus:

Définir le paramètre de requête Stealth par défaut
Explication
stealth_urlL'URL vers laquelle vous voulez que votre domaine redirige. Veuillez noter que le paramètre doit être encodé afin que l'appel API soit interprété correctement.
stealth_title (optional)Le titre de la page
Balise XML de résultat
Explication
<SetDefaultStealthResponse></SetDefaultStealthResponse>Nœud racine du document XML de réponse
<SetDefaultStealthHeader></SetDefaultStealthHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du Stealth par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Réponse (format XML)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com
Réponse (format JSON)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition de l'hébergement par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set default hosting, les paramètres suivants doivent être inclus :

Définir le paramètre de requête d'hébergement par défaut
Explication
hosting_typeType de l'hébergement par défaut que vous voulez, vous pouvez le sélectionner dans "advanced" et "basic"
Balise XML de résultat
Explication
<SetDefaultHostingResponse></SetDefaultHostingResponse>Nœud racine du document XML de réponse
<SetDefaultHostingHeader></SetDefaultHostingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition d'hébergement par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
Réponse (format XML)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_hosting&hosting_type=advanced
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_hosting&hosting_type=advanced
Réponse (format JSON)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition du DNS par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du DNS par défaut, les paramètres suivants doivent être inclus :

( Cette commande est obsolète et non recommandée, veuillez plutôt utiliser la commande Définir DNS2 par défaut )

Définir le paramètre de requête DNS par défaut
Explication
main_record_typeType d'enregistrement principal
main_recordSpécifiez un enregistrement DNS pour votre domaine
main_txt (optional)Spécifiez un enregistrement TXT pour votre domaine. Si votre main_record_type est aaaa et que vous avez spécifié un main_record2, vous pouvez définir jusqu'à 3 main_txts, sinon, vous pouvez définir jusqu'à 4 main_txts.
main_record2Enregistrement principal 2, utilisé uniquement lorsque "main_record_type" est "aaaa". Sa valeur doit être au format ipv4.
subdomain0 - subdomain99 (optional)Enregistrements de sous-domaine
sub_record_type0 - sub_record_type99 (optional)Type d'enregistrements de sous-domaine
sub_record0 - sub_record99 (optional)Adresse IP ou hôte cible
mx_host0 - mx_host2 (optional)Spécifiez l'hôte de messagerie pour votre domaine, distance0 est la priorité la plus élevée.
mx_distance0 - mx_distance2 (optional)Distance0 est la priorité la plus élevée
ttl (optional)Durée de vie
Balise XML de résultat
Explication
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nœud racine du document XML de réponse
<SetDefaultDnsHeader></SetDefaultDnsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du DNS par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Réponse (format XML)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Réponse (format JSON)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition du DNS2 par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du DNS par défaut, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir le DNS2 par défaut
Explication
main_record_type0 - main_record_type19Type d'enregistrement principal
main_record0 - main_record19Spécifiez l'enregistrement DNS pour votre domaine
main_recordx0 - main_recordx19Distance MX, type de redirection, titre de redirection masquée ou alias e-mail, nécessaire lorsque main_record est "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
subdomain0 - subdomain99 (optional)Enregistrements de sous-domaine
sub_record_type0 - sub_record_type99 (optional)Type d'enregistrements de sous-domaine
sub_record0 - sub_record99 (optional)Adresse IP du sous-domaine ou hôte cible
sub_recordx0 - subdo_recordx99Mx distance, type de transfert, titre de transfert furtif ou alias e-mail, nécessaire lorsque sub_record_type est "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
ttl (optional)Durée de vie
Balise XML de résultat
Explication
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nœud racine du document XML de réponse
<SetDefaultDnsHeader></SetDefaultDnsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du DNS2 par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Réponse (format XML)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Réponse (format JSON)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition du transfert d'e-mail par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set default email forward, les paramètres suivants doivent être inclus :

Paramètre de requête de définition du transfert d'e-mail par défaut
Explication
forward_typeType de redirection, il peut être "donot" : Ne pas rediriger les e-mails, "mx" : Livrer les e-mails à un autre hôte de messagerie (enregistrement MX), "forward" : Livrer les e-mails à un autre hôte de messagerie
username0 - username9Nom d'utilisateur, utilisé uniquement quand "forward_type" est "forward"
exist_email0 - exist_email9Adresse e-mail existante, utilisée uniquement lorsque "forward_type" est "forward"
mx_host0 - mx_host2Hôte de messagerie, utilisé uniquement lorsque "forward_type" est "mx"
mx_distance0 - mx_distance2Distance0 est la priorité la plus élevée, à utiliser uniquement lorsque "forward_type" est "mx"
Balise XML de résultat
Explication
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Nœud racine du document XML de réponse
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du transfert d'e-mail par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Réponse (format XML)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_email_forward&forward_type=forward&username0=test&[email protected]
Réponse (format JSON)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Clear Default Setting

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set clear default setting, les paramètres suivants doivent être inclus :

Définir le paramètre de requête d'effacement du paramètre par défaut
Explication
serviceLe service que vous souhaitez effacer, il peut être "forward", "stealth", "email_forwarding", "dns" et "nameservers"
Balise XML de résultat
Explication
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Nœud racine du document XML de réponse
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de commande Set Clear Default Setting

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_default_setting&service=nameservers
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
Réponse (format XML)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_default_setting&service=nameservers
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_default_setting&service=nameservers
Réponse (format JSON)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande pour définir l'option de renouvellement par défaut

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition de l'option de renouvellement par défaut, les paramètres suivants doivent être inclus:

Paramètre de requête pour définir l'option de renouvellement par défaut
Explication
renew_optionCela peut être "donot", "auto", "reset"
Balise XML de résultat
Explication
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Nœud racine du document XML de réponse
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de l'option de renouvellement par défaut

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_default_renew_option&renew_option=auto
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_default_renew_option&renew_option=auto
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_default_renew_option&renew_option=auto
Réponse (format JSON)
{
  "SetDefaultRenewOptionResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de création de dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande create folder, les paramètres suivants doivent être inclus :

Paramètre de requête de création de dossier
Explication
folder_nameNom du dossier que vous souhaitez créer
Balise XML de résultat
Explication
<FolderCreateResponse></FolderCreateResponse>Nœud racine du document XML de réponse
<FolderCreateHeader></FolderCreateHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<FolderCreateContent></FolderCreateContent>Contenu de la réponse
<FolderName></FolderName>nom du dossier
<FolderId></FolderId>ID du nouveau dossier

Exemple de création de dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=create_folder&folder_name=new
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=create_folder&folder_name=new
Réponse (format XML)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=create_folder&folder_name=new
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=create_folder&folder_name=new
Réponse (format JSON)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

Commande de suppression de dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set Whois, les paramètres suivants doivent être inclus:

Paramètre de requête de suppression de dossier
Explication
folder_idL'ID des dossiers que vous souhaitez supprimer, assurez-vous qu'ils sont séparés par des virgules
Balise XML de résultat
Explication
<DeleteFolderResponse></DeleteFolderResponse>Nœud racine du document XML de réponse
<DeleteFolderHeader></DeleteFolderHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de suppression de dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_folder&folder_id=0,1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_folder&folder_id=0,1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_folder&folder_id=0,1
Réponse (format JSON)
{
  "DeleteFolderResponse": {
    "SuccessCode": 0,
    "Status": "success"
  }
}
 

Commande de définition du Whois du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder Whois, les paramètres suivants doivent être inclus:

Définir le paramètre de requête Whois du dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir
registrant_contactLes informations du titulaire du domaine
admin_contactLes informations de l'administrateur du domaine
technical_contactLes informations techniques du domaine
billing_contactLes informations de facturation du domaine
enable (optional)Si vous souhaitez appliquer ce paramètre Whois aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser ce réglage Whois pour tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderWhoisResponse></SetFolderWhoisResponse>Nœud racine du document XML de réponse
<SetFolderWhoisHeader></SetFolderWhoisHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration du Whois de dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Réponse (format XML)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Réponse (format JSON)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition des serveurs de noms du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder name servers, les paramètres suivants doivent être inclus :

Paramètre de requête pour définir les serveurs de noms du dossier
Explication
fold_idL'ID du dossier que vous souhaitez définir, un seul dossier peut être défini par requête
ns0 - ns12Les serveurs de noms à configurer pour votre domaine, vous pouvez en spécifier jusqu'à 13, mais ils doivent déjà être dans votre compte
enable (optional)Si vous souhaitez appliquer ce paramètre de serveurs de noms aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser le réglage des serveurs de noms de tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderNsResponse></SetFolderNsResponse>Balise de la réponse du serveur pour définir le nom du dossier, c'est le nœud racine du document XML de réponse
<SetFolderNsHeader></SetFolderNsHeader>Tag de l'en-tête de réponse du serveur de noms du dossier défini
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<SetFolderNsContent></SetFolderNsContent>Étiquette du contenu de la réponse du serveur de noms du dossier défini, elle n'est utilisée que lorsque le statut est "success"
<Servers></Servers>Les informations des serveurs que vous avez définis
<Server></Server>Chaque serveur
<ServerName></ServerName>Nom du serveur
<ServerId></ServerId>ID du serveur

Exemple de définition des Ns du dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderNsResponse>
  <SetFolderNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNsHeader>
  <SetFolderNsContent>
    <Servers>
      <Server>
        <ServerName>ns1.hosts.com</ServerName>
        <ServerId>0</ServerId>
      </Server>
      <Server>
        <ServerName>ns2.hosts.com</ServerName>
        <ServerId>1</ServerId>
      </Server>
    </Servers>
  </SetFolderNsContent>
</SetFolderNsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Réponse (format JSON)
{
  "SetFolderNsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetFolderNsContent": {
      "Servers": [
        {
          "ServerName": "ns1.hosts.com",
          "ServerId": "0"
        },
        {
          "ServerName": "ns2.hosts.com",
          "ServerId": "1"
        }
      ]
    }
  }
}
 

Commande de définition du parking de dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du dossier de parking, les paramètres suivants doivent être inclus :

Paramètre de requête de définition du parking de dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir, un seul dossier peut être défini par requête
with_ads (optional)Si vous ne voulez pas d'annonces tierces, vous pouvez utiliser ce paramètre avec "no", la valeur par défaut est "yes"
enable (optional)Si vous souhaitez appliquer ce paramètre de parking aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser le réglage de parking de tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderParkingResponse></SetFolderParkingResponse>Nœud racine du document XML de réponse
<SetFolderParkingHeader></SetFolderParkingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de stationnement de dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Réponse (format XML)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_parking&folder_id=0&with_ads=no
Réponse (format JSON)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition de la redirection de dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder forwarding, les paramètres suivants doivent être inclus :

Définir le paramètre de requête de transfert de dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir
forward_urlL'URL vers laquelle vous voulez que votre domaine redirige. Veuillez noter que le paramètre doit être encodé afin que l'appel API soit interprété correctement.
is_temp (optional)Statut de redirection souhaité pour votre domaine, la valeur par défaut est "temporary", si vous souhaitez rediriger définitivement, utilisez ce paramètre avec "no"
enable (optional)Si vous souhaitez appliquer ce paramètre de redirection aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser le réglage de redirection de tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderForwardingResponse></SetFolderForwardingResponse>Nœud racine du document XML de réponse
<SetFolderForwardingHeader></SetFolderForwardingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration de la redirection d'un dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Réponse (format XML)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes
Réponse (format JSON)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Stealth

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder stealth, les paramètres suivants doivent être inclus :

Paramètre de requête de définition de la furtivité du dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir
stealth_urlL'URL vers laquelle vous voulez que votre domaine redirige. Veuillez noter que le paramètre doit être encodé afin que l'appel API soit interprété correctement.
stealth_title (optional)Le titre de la page
enable (optional)Si vous souhaitez appliquer ce paramètre stealth aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser le réglage furtif de tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderStealthResponse></SetFolderStealthResponse>Nœud racine du document XML de réponse
<SetFolderStealthHeader></SetFolderStealthHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de configuration du mode furtif du dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Réponse (format XML)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes
Réponse (format JSON)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition de l'hébergement du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder hosting, les paramètres suivants doivent être inclus :

Définir le paramètre de requête d'hébergement du dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir
hosting_typeType d'hébergement souhaité, vous pouvez choisir entre "advanced" et "basic"
enable (optional)Si vous souhaitez appliquer ce réglage d'hébergement aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
even (optional)Si vous souhaitez synchroniser le réglage d'hébergement de tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderHostingResponse></SetFolderHostingResponse>Nœud racine du document XML de réponse
<SetFolderHostingHeader></SetFolderHostingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de l'hébergement du dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Réponse (format XML)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Réponse (format JSON)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition du DNS du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder DNS, les paramètres suivants doivent être inclus :

( Cette commande est obsolète et n'est pas recommandée, veuillez utiliser la commande Set Folder DNS2 à la place )

Paramètre de requête de définition du DNS du dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir
main_record_typeType d'enregistrement principal
main_recordSpécifiez un enregistrement DNS pour votre domaine
main_recordSpécifiez un enregistrement DNS pour votre domaine
with_ads (optional)Spécifiez un enregistrement TXT pour votre domaine. Si votre main_record_type est aaaa et que vous avez spécifié un main_record2, vous pouvez définir jusqu'à 3 main_txts, sinon, vous pouvez définir jusqu'à 4 main_txts.
main_record2Enregistrement principal 2, utilisé uniquement lorsque "main_record_type" est "aaaa". Sa valeur doit être au format ipv4.
subdomain0 - subdomain99 (optional)Enregistrements de sous-domaine (facultatif)
sub_record_type0 - sub_record_type99 (optional)Type d'enregistrements de sous-domaine
sub_record0 - sub_record99 (optional)Adresse IP ou hôte cible
mx_host0 - mx_host2 (optional)Spécifiez l'hôte de messagerie pour votre domaine, distance0 est la priorité la plus élevée.
mx_distance0 - mx_distance2 (optional)Distance0 est la priorité la plus élevée
ttl (optional)Durée de vie
enable (optional)Si vous voulez appliquer ce réglage DNS aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser ce réglage de serveur DNS pour tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderDnsResponse></SetFolderDnsResponse>Nœud racine du document XML de réponse
<SetFolderDnsHeader></SetFolderDnsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition DNS du dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Réponse (format XML)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Réponse (format JSON)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Définir la commande DNS2 du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder DNS2, les paramètres suivants doivent être inclus:

Paramètre de requête Set Folder DNS2
Explication
folder_idL'ID du dossier que vous souhaitez définir
main_record_type0 - main_record_type19Type d'enregistrement principal, doit être "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Spécifiez l'enregistrement DNS pour votre domaine
main_recordx0 - main_recordx19Distance MX, type de redirection, titre de redirection furtive ou alias e-mail, nécessaire lorsque main_record_type est "forward","mx","stealth","email"
subdomain0 - subdomain99 (optional)Enregistrements de sous-domaine (facultatif)
sub_record_type0 - sub_record_type99 (optional)Type d'enregistrements de sous-domaine, doit être "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (optional)Adresse IP ou hôte cible
sub_recordx0 - sub_recordx99 (optional)Distance MX, type de redirection, titre de redirection masquée ou alias e-mail, nécessaire lorsque sub_record_type est "forward","mx","stealth","email"
ttl (optional)Durée de vie
enable (optional)Si vous voulez appliquer ce réglage DNS aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser ce réglage de serveur DNS pour tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderDnsResponse></SetFolderDnsResponse>Nœud racine du document XML de réponse
<SetFolderDnsHeader></SetFolderDnsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du dossier Dns2

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Réponse (format JSON)
{
  "SetFolderDnsResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de définition du transfert d'e-mail du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder email forward, les paramètres suivants doivent être inclus :

Paramètre de requête de définition du transfert d'e-mail de dossier
Explication
domainLe nom de domaine que vous souhaitez définir, 100 domaines peuvent être définis par requête, assurez-vous qu'ils sont séparés par des virgules
folder_idID du dossier que vous souhaitez définir
forward_typeType de redirection, il peut être "donot" : Ne pas rediriger les e-mails, "mx" : Livrer les e-mails à un autre hôte de messagerie (enregistrement MX), "forward" : Livrer les e-mails à un autre hôte de messagerie
username0 - username9Nom d'utilisateur, utilisé uniquement quand "forward_type" est "forward"
exist_email0 - exist_email9Adresse e-mail existante, utilisée uniquement lorsque "forward_type" est "forward"
mx_host0 - mx_host2Hôte de messagerie, utilisé uniquement lorsque "forward_type" est "mx"
mx_distance0 - mx_distance2Distance0 est la priorité la plus élevée, à utiliser uniquement lorsque "forward_type" est "mx"
enable (optional)Si vous souhaitez appliquer ce paramètre aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser ce réglage pour tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Nœud racine du document XML de réponse
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de Set Folder Email Forward

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Réponse (format XML)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=test&[email protected]
Réponse (format JSON)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition du paramètre d'effacement du dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set clear folder setting, les paramètres suivants doivent être inclus :

Définir le paramètre de requête de réglage d'effacement de dossier
Explication
folder_idL'ID du dossier que vous souhaitez définir
serviceLe service que vous souhaitez effacer, il peut être "forward", "stealth", "email_forwarding", "dns" et "nameservers"
Balise XML de résultat
Explication
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nœud racine du document XML de réponse
<SetClearFolderSettingHeader></SetClearFolderSettingHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition/effacement des paramètres de dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Réponse (format XML)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_clear_folder_setting&folder_id=0&service=nameservers
Réponse (format JSON)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de définition du nom de dossier

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande de définition du nom de dossier, les paramètres suivants doivent être inclus :

Paramètre de requête de définition du nom de dossier
Explication
folder_idID du dossier que vous souhaitez définir
folder_nameNom du nouveau dossier
Balise XML de résultat
Explication
<SetFolderNameResponse></SetFolderNameResponse>Nœud racine du document XML de réponse
<SetFolderNameHeader></SetFolderNameHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition du nom de dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
Réponse (format XML)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_name&folder_id=0&folder_name=new
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_name&folder_id=0&folder_name=new
Réponse (format JSON)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande Set Folder Renew Option

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Si vous appelez la commande set folder renew option, les paramètres suivants doivent être inclus :

Paramètre de requête Set Folder Renew Option
Explication
folder_idL'ID du dossier que vous souhaitez définir, un seul dossier peut être défini par requête
renew_optionL'option de renouvellement que vous voulez définir pour le dossier ; elle peut être "donot", "auto" ou "reset"
enable (optional)Si vous souhaitez appliquer ce paramètre de renouvellement aux futurs domaines que vous déplacez dans ce dossier, vous pouvez utiliser ce paramètre avec "yes"
sync (optional)Si vous souhaitez synchroniser le réglage de renouvellement de tous les domaines de ce dossier, vous pouvez utiliser ce paramètre avec "yes"
Balise XML de résultat
Explication
<Response></Response>Nœud racine du document XML de réponse
<ResponseHeader></ResponseHeader>En-tête de réponse
<ResponseCode></ResponseCode>Code de réponse, "0" en cas de succès, "-1" en cas d'échec
<Error></Error>Informations d'erreur, à utiliser uniquement lorsque le code de réponse est "-1"

Exemple de définition de l'option de renouvellement du dossier

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Réponse (format XML)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_folder_renew_option&folder_id=0&renew_option=auto
Réponse (format JSON)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de liste des dossiers

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Cette commande est uniquement disponible au format XML et JSON :

Paramètre de requête de liste de dossiers
Explication
N/AAucun paramètre supplémentaire nécessaire
<FolderListResponse></FolderListResponse>Nœud racine du document XML de réponse
<FolderListHeader></FolderListHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<FolderListContent></FolderListContent>Contenu de la réponse
<FolderList></FolderList>Liste des dossiers
<List></List>
<Folder></Folder>
<FolderId></FolderId>ID du dossier
<FolderName></FolderName>Nom du dossier
<DefaultWhois></DefaultWhois>Whois par défaut
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Statut d'activation Whois par défaut
<DefaultRegistrant></DefaultRegistrant>Titulaire par défaut
<ContactId></ContactId>ID du contact
<DefaultAdmin></DefaultAdmin>Administrateur par défaut
<DefaultTechnical></DefaultTechnical>Informations techniques par défaut
<DefaultBilling></DefaultBilling>Informations de facturation par défaut
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Statut d'activation du serveur de noms par défaut
<NameServerSettings></NameServerSettings>Paramètres du serveur de noms
<Type></Type>Type de serveur de noms
<WithAds></WithAds>Avec ou sans publicités
<DefaultRenewOption></DefaultRenewOption>Option de renouvellement par défaut
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Statut d'activation de l'option de renouvellement par défaut
<RenewOption></RenewOption>Option de renouvellement
<DefaultTransferLock></DefaultTransferLock>Verrouillage de transfert par défaut
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Statut d'activation du verrouillage de transfert par défaut
<LockStatus></LockStatus>Statut de verrouillage

Exemple de liste de dossiers

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=folder_list
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=folder_list
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>Yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=folder_list
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=folder_list
Réponse (format JSON)
{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}
 

Commande d'ajout de demande de backorder

Prise en charge du multi-thread
API Sandbox non prise en charge

Lors de l'appel de la commande add backorder request, les paramètres suivants doivent être inclus :

Paramètre de requête pour l'ajout d'une demande de backorder
Explication
domainLe(s) domaine(s) que vous souhaitez ajouter et pour le(s)quel(s) vous acceptez de payer si Dynadot les attrape, 100 domaines peuvent être ajoutés par requête, ils doivent être séparés par des virgules
Balise XML de résultat
Explication
<AddBackorderRequestResponse></AddBackorderRequestResponse>Nœud racine du document XML de réponse
<AddBackorderRequestHeader></AddBackorderRequestHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de requête d'ajout de backorder

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Réponse (format XML)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Réponse (format JSON)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de suppression de demande de backorder

Prise en charge du multi-thread
API Sandbox non prise en charge

Si vous appelez la commande de requête delete backorder, les paramètres suivants doivent être inclus :

Paramètre de requête pour la suppression d'une demande de backorder
Explication
domainLe(s) domaine(s) que vous souhaitez retirer de votre liste de demandes de backorder, 100 domaines peuvent être retirés par requête, ils doivent être séparés par des virgules
Balise XML de résultat
Explication
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Nœud racine du document XML de réponse
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de requête de suppression de backorder

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
Réponse (format XML)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=delete_backorder_request&domain=domaindropp.com
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=delete_backorder_request&domain=domaindropp.com
Réponse (format JSON)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Commande de liste des demandes de backorder

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande de liste de demandes de backorder renverra une liste des demandes de backorder du compte spécifié. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête de la liste des demandes de backorder
Explication
start_dateDate de début du drop de l'enchère que vous souhaitez demander, yyyy-mm-dd, comme 2015-05-05
end_dateDate de fin de drop de l'enchère que vous souhaitez demander, yyyy-mm-dd, comme 2015-05-05
Balise XML de résultat
Explication
<BackorderRequestListResponse></BackorderRequestListResponse>Nœud racine du document XML de réponse
<BackorderRequestListHeader></BackorderRequestListHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<BackorderRequestListContent></BackorderRequestListContent>Contenu de la réponse
<BackorderRequestList></BackorderRequestList>Liste des demandes de réservation
<BackorderRequest></BackorderRequest>Demande de backorder
<Domain></Domain>Domaine dans votre liste
<CutoffTime></CutoffTime>Date limite pour supprimer une requête en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<BackorderRequestStatus></BackorderRequestStatus>Statut dans le processus de drop catching

Exemple de liste de requêtes de backorder

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Réponse (format JSON)
{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}
Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Réponse (format CSV)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
 

Commande pour obtenir les enchères ouvertes

Prise en charge du multi-thread
API Sandbox non prise en charge

Appeler la commande get open auctions renvoie une liste des enchères en cours. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête Get Open Auctions
Explication
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
type (optional)Le type d'enchère que vous voulez voir, il doit être "expired", "user", "backorder", ou "registry_expired", "registrar", si vous voulez obtenir plus d'un type d'enchère, vous pouvez utiliser "," pour séparer chaque type d'enchère
count_per_pageCombien d'entités sont affichées par page (maximum 1000)
page_index Quelles entités de page voulez-vous afficher
has_bids (optional)Lorsque ce paramètre est vrai, seules les enchères sur lesquelles une mise a été placée sont renvoyées. S'il est faux, il renvoie les enchères sans mise. S'il n'est pas transmis, il renvoie toutes les enchères.
Balise XML de résultat
Explication
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Balise de la réponse get open auctions, c'est le nœud racine du document XML de réponse
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Obtenir l'en-tête des enchères ouvertes
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Tag of get open auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID de l'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Prix actuel de l'offre aux enchères
<BidPriceCurrency></BidPriceCurrency>Devise du prix de l'enchère
<Bids></Bids>Nombre d'offres pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<Revenue></Revenue>Revenu de l'enchère
<RevenueCurrency></RevenueCurrency>Devise des revenus
<Visitors></Visitors>Visiteurs du domaine
<Links></Links>Liens entrants du domaine
<Age></Age>Âge du domaine

Exemple d'obtention des enchères ouvertes

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Réponse (format XML)
<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>
Requête (format csv)

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

Réponse

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

Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_open_auctions&currency=usd&type=expired&count_per_page=20&page_index=1
Réponse (format JSON)
{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-"
        }
        ...
    ]
}
 

Commande Get Auction Details

Prise en charge du multi-thread
API Sandbox non prise en charge

Appeler la commande get auction details renverra les détails de l'enchère spécifiée. Cette commande est uniquement disponible au format XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus:

Paramètre de requête pour obtenir les détails de l'enchère
Explication
domainLe nom de domaine de l'enchère, IDN(nom de domaine international) doit utiliser punycode, tel que "xn--wkccg.com". vous pouvez obtenir plusieurs enchères, chaque domaine doit être séparé par ","
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Balise de la réponse d'obtention des détails de l'enchère, c'est le nœud racine du document XML de réponse
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>En-tête de récupération des détails de l'enchère de backorder
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>ID du statut de l'enchère : '0' pour En cours, '1' pour Annulée par l'utilisateur, '2' pour Annulée par l'administrateur, '3' pour Annulée par renouvellement, '4' pour Terminée, '5' pour Annulée par transfert sortant
<AuctionStatus></AuctionStatus>Statut de l'enchère
<UserIsHighBid></UserIsHighBid>Si l'utilisateur est le plus offrant
<YourCurrentBid></YourCurrentBid>Votre prix d'enchère actuel pour l'enchère spécifiée. Si vous n'avez pas placé d'enchère, il sera '-1'
<YourProxyBid></YourProxyBid>Votre enchère proxy pour l'enchère spécifiée. Si vous n'avez pas placé d'offre, ce sera '-1'
<AuctionId></AuctionId>ID de l'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Prix actuel de l'offre aux enchères
<BidPriceCurrency></BidPriceCurrency>Devise du prix de l'enchère
<Bids></Bids>Nombre d'offres pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<IsPremium></IsPremium>Indique s'il s'agit d'un domaine premium
<RenewalPrice></RenewalPrice>Prix de renouvellement

Exemple de récupération des détails de l'enchère

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd
Réponse (format JSON)
{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "dyna_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}
 

Commande Get Auction Bids

Prise en charge du multi-thread
API Sandbox non prise en charge

Appeler la commande get auction bids récupérera votre liste d'offres auxquelles vous avez participé. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir les offres d'enchères
Explication
currency (optional)La devise de votre enchère, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
count_per_pageCombien d'entités sont affichées par page (maximum 50)
page_index Quelles entités de page voulez-vous afficher
Balise XML de résultat
Explication
<GetAuctionBidsResponse></GetAuctionBidsResponse>Balise de la réponse d'obtention des offres d'enchères, c'est le nœud racine du document XML de réponse
<GetAuctionBidsHeader></GetAuctionBidsHeader>En-tête de Get auction bids
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> Liste des enchères
<Bid></Bid> Élément d'enchère
<BidId></BidId> ID de l'enchère
<AuctionId></AuctionId> ID de l'enchère
<AccountId></AccountId>ID du compte
<Domain></Domain>Nom de domaine de l'enchère
<DomainUtf></DomainUtf>Nom utf du domaine de l'enchère
<AuctionType></AuctionType>Type d'enchère
<IsIdn></IsIdn>Si ce domaine est un nom de domaine internationalisé
<CurrentBid></CurrentBid>Prix actuel de l'offre pour l'enchère
<YourStatus></YourStatus>Le statut de votre enchère pour la vente aux enchères
<ProxyBid></ProxyBid>Votre prix d'enchère proxy pour l'enchère
<ActiveBidders></ActiveBidders>Le nombre d'enchérisseurs qui participent à cette enchère
<TimeLeft></TimeLeft>le temps restant pour l'enchère
<EndTime></EndTime>Date et heure de fin de l'enchère
<EndTimestamp></EndTimestamp>L'horodatage de fin de l'enchère

Exemple de récupération des offres d'enchères

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Réponse (format XML)
<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_auction_bids&currency=usd&count_per_page=20&page_index=1
Réponse (format JSON)
{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}
 

Commande de placement d'enchère aux enchères

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande de placement d'enchère placera une enchère pour l'enchère spécifiée. Si vous appelez cette commande, les paramètres suivants doivent être inclus:

Paramètre de requête pour placer une offre aux enchères
Explication
domainLe nom de domaine de l'enchère, IDN (nom de domaine internationalisé) doit utiliser punycode, tel que "xn--wkccg.com"
bid_amountVotre montant d'offre pour l'enchère, la devise par défaut est le dollar américain, vous pouvez aussi la spécifier via le paramètre currency ci-dessous
currency (optional)La devise de votre enchère, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Balise de réponse à l'offre d'enchère, c'est le nœud racine du document XML de réponse
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>En-tête de placement d'une enchère
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de domaine

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Réponse (format XML)
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
Requête (format csv)

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

Réponse

ok,success

Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Réponse (format JSON)
{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "dyna_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}
 

Commande de récupération des enchères terminées

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande get closed auctions renverra une liste des enchères clôturées du compte spécifié. Si vous appelez cette commande, les paramètres suivants doivent être inclus:

Paramètre de requête pour Get Closed Auctions
Explication
start_dateL'horodatage indiquant le début de l'heure de fin de l'enchère, yyyy-mm-dd, comme 2015-05-05
end_dateL'horodatage indiquant la fin de l'heure de clôture de l'enchère, yyyy-mm-dd, comme 2015-05-05
currency (optional)La devise de votre enchère, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Balise de la réponse get closed auctions, c'est le nœud racine du document XML de réponse
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Obtenir l'en-tête des enchères clôturées
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID de l'enchère
<Domain></Domain>Nom de domaine de l'enchère
<AuctionStatusId></AuctionStatusId>ID du statut de l'enchère, '0' pour En cours et '1' pour Clôturée par l'utilisateur, '2' pour Clôturée par l'admin, '3' pour Clôturée par renouvellement, '4' pour Clôturée par expiration, '5' pour Clôturée par transfert sortant
<AuctionStatus></AuctionStatus>Statut de l'enchère
<BidPrice></BidPrice>Prix actuel de l'offre aux enchères
<BidPriceCurrency></BidPriceCurrency>Devise du prix de l'enchère
<Bids></Bids>Nombre d'offres pour l'enchère
<AuctionWonStatus></AuctionWonStatus>Si l'utilisateur a remporté cette enchère
<YourHighBid></YourHighBid>Votre enchère maximale pour cette vente aux enchères
<YourProxyBid></YourProxyBid>Votre enchère proxy pour cette vente aux enchères

Exemple de récupération des enchères clôturées

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Réponse (format JSON)
{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}
Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Réponse (format CSV)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
 

Commande d'obtention des enchères de backorder ouvertes

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande get open backorder auctions renverra une liste des enchères de backorder en cours. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir les enchères de backorder ouvertes
Explication
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Balise de la réponse get open backorder auctions, c'est le nœud racine du document XML de réponse
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Obtenir l'en-tête des enchères de backorder ouvertes
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag of get open backorder auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID de l'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Prix actuel de l'offre aux enchères
<BidPriceCurrency></BidPriceCurrency>Devise du prix de l'enchère
<Bids></Bids>Nombre d'offres pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)

Exemple de récupération des enchères de backorder ouvertes

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_open_backorder_auctions&currency=usd
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_open_backorder_auctions&currency=usd
Réponse (format XML)
<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>
Requête (format csv)

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

Réponse

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

 

Commande d'obtention des détails de l'enchère de backorder

Prise en charge du multi-thread
API Sandbox non prise en charge

Appeler la commande get backorder auction details renverra les détails de l'enchère spécifiée. Cette commande est uniquement disponible aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir les détails de l'enchère
Explication
domainLe nom de domaine de l'enchère de backorder, IDN (International Domain Name) doit utiliser punycode, comme "xn--wkccg.com"
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Balise de la réponse d'obtention des détails de l'enchère, c'est le nœud racine du document XML de réponse
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>En-tête de récupération des détails de l'enchère
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>ID du statut de l'enchère, '0' pour En cours et '1' pour Clôturée par l'utilisateur, '2' pour Clôturée par l'admin, '3' pour Clôturée par renouvellement, '4' pour Clôturée par expiration, '5' pour Clôturée par transfert sortant
<AuctionStatus></AuctionStatus>Statut de l'enchère
<AuctionId></AuctionId>ID de l'enchère
<Domain></Domain>Nom de domaine de l'enchère
<BidPrice></BidPrice>Prix actuel de l'offre aux enchères
<BidPriceCurrency></BidPriceCurrency>Devise du prix de l'enchère
<Bids></Bids>Nombre d'offres pour l'enchère
<EndTime></EndTime>Heure de fin de l'enchère
<EndTimestamp></EndTimestamp>Date de fin de l'enchère en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<Revenue></Revenue>Revenu de l'enchère
<RevenueCurrency></RevenueCurrency>Devise des revenus
<Visitors></Visitors>Visiteurs du domaine
<Links></Links>Liens entrants du domaine
<Age></Age>Âge du domaine
<UserIsHighBid></UserIsHighBid>Si l'utilisateur est le plus offrant
<YourCurrentBid></YourCurrentBid>Votre prix d'enchère actuel pour l'enchère spécifiée. Si vous n'avez pas placé d'enchère, il sera '-1'
<YourProxyBid></YourProxyBid>Votre enchère proxy pour l'enchère spécifiée. Si vous n'avez pas placé d'offre, ce sera '-1'

Exemple d'obtention des détails de l'enchère de Backorder

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_backorder_auction_details&domain=example.com&currency=usd
Réponse (format JSON)
{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}
 

Commande de placement d'enchère dans une vente aux enchères de backorder

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande place backorder auction bid placera une offre pour l'enchère backorder spécifiée. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête de mise d'enchère pour une vente aux enchères de backorder
Explication
domainLe nom de domaine de l'enchère, IDN (nom de domaine internationalisé) doit utiliser punycode, tel que "xn--wkccg.com"
bid_amountVotre montant d'offre pour l'enchère, la devise par défaut est le dollar américain, vous pouvez aussi la spécifier via le paramètre currency ci-dessous
currency (optional)La devise de votre enchère, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Balise de réponse à l'offre d'enchère, c'est le nœud racine du document XML de réponse
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>En-tête de placement d'une enchère
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de dépôt d'enchère pour une réservation aux enchères

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Réponse (format XML)
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Réponse (format JSON)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd
Réponse (format CSV)
ok,success
 

Commande pour obtenir les enchères de backorder fermées

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande get closed backorder auctions renverra une liste des enchères de backorder fermées du compte spécifié. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête Get Closed Backorder Auctions
Explication
start_dateDate de début de l'enchère, aaaa-mm-jj, comme 2015-05-05
end_dateDate de fin de l'enchère, yyyy-mm-dd, comme 2015-05-05
currency (optional)La devise de votre enchère, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Balise de la réponse get closed auctions, c'est le nœud racine du document XML de réponse
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Obtenir l'en-tête des enchères clôturées
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<YourHighBid></YourHighBid>Votre enchère maximale pour cette vente aux enchères
<YourProxyBid></YourProxyBid>Votre enchère proxy pour cette vente aux enchères
<AuctionId></AuctionId>ID de l'enchère
<Domain></Domain>Nom de domaine de l'enchère
<AuctionStatusId></AuctionStatusId>ID du statut de l'enchère, '0' pour En cours et '1' pour Clôturée par l'utilisateur, '2' pour Clôturée par l'admin, '3' pour Clôturée par renouvellement, '4' pour Clôturée par expiration, '5' pour Clôturée par transfert sortant
<AuctionStatus></AuctionStatus>Statut de l'enchère
<BidPrice></BidPrice>Prix actuel de l'offre aux enchères
<BidPriceCurrency></BidPriceCurrency>Devise du prix de l'enchère
<Bids></Bids>Nombre d'offres pour l'enchère

Exemple de Get Closed Backorder Auctions

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Réponse (format JSON)
{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}
Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Réponse (format CSV)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
 

Commande pour obtenir les domaines expirés en liquidation

Prise en charge du multi-thread
API Sandbox non prise en charge

Appeler la commande Get Expired Closeout Domains permet d'obtenir les domaines Closeout expirés. Cette commande est uniquement disponible aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir les domaines expirés en liquidation
Explication
currency(optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
domain(optional)Ajoutez ce paramètre si vous souhaitez rechercher un domaine en liquidation
count_per_page (optional)Combien d'entités sont affichées par page
page_index (optional)Quelles entités de page voulez-vous afficher
Balise XML de résultat
Explication
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Balise de la réponse Get Expired Closeout Domains, c'est le nœud racine du document XML de réponse
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Obtenir l'en-tête des domaines expirés en liquidation
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>Article de liquidation
<DomainName></DomainName>Le nom de domaine
<DomainNameUtf></DomainNameUtf>Le nom de domaine est au format utf
<CurrentPrice></CurrentPrice>prix actuel
<isIdn></isIdn>Indique s'il s'agit du nom de domaine IDN
<EndTimeStamp></EndTimeStamp>Date de fin de l'enchère en temps Unix (millisecondes depuis minuit UTC du 1er janvier 1970)
<RenewalPrice></RenewalPrice>Prix de renouvellement
<ExpiredRevenue></ExpiredRevenue>Revenu de la liquidation
<DynaAppraisal></DynaAppraisal>DynaAppraisal
<InboundLinks></InboundLinks>Liens entrants du domaine
<MonthlyVisitors></MonthlyVisitors>Visiteurs du domaine
<Currency></Currency>Devise

Exemple de récupération des domaines expirés en liquidation

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains&currency=usd
Réponse (format JSON)
{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}
 

Commande Buy Expired Closeout Domain

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande Buy Expired Closeout Domain achètera le nom de domaine spécifié. Cette commande n'est disponible qu'aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête pour l'achat d'un domaine expiré en liquidation
Explication
domainLe domaine que vous souhaitez acheter, un seul domaine peut être saisi par requête
currency(optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Balise de la réponse Buy Expired Closeout Domain, c'est le nœud racine du document XML de réponse
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>En-tête Acheter un domaine expiré en liquidation
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple d'achat de domaine expiré en liquidation

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=buy_expired_closeout_domain&currency=USD&domain=domain.com
Réponse (format JSON)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Commande Get Listings

Prise en charge du multi-thread
API Sandbox non prise en charge

Si vous appelez la commande get listings, les paramètres suivants doivent être inclus :

Paramètre de requête Get Listings
Explication
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
exclude_pending_sale (optional)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
show_other_registrar (optional)Si vous voulez obtenir d'autres listes de registrars, cela doit être "yes", par défaut c'est "no"
count_per_pageCombien d'entités sont affichées par page. (maximum 20000)
page_indexDe quelle page souhaitez-vous voir les entités ?
Balise XML de résultat
Explication
<GetListingsResponse></GetListingsResponse>Nœud racine du document XML de réponsedocument XML
<GetListingsHeader></GetListingsHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetListingsContent></GetListingsContent>Contenu de l'annonce
<Listing></Listing>Contenu de l'élément d'annonce
<ListingId></ListingId>ID de l'annonce
<Domain></Domain>Nom de domaine
<Price></Price>Prix
<InBoundLinks></InBoundLinks>Nombre de liens entrants
<Age></Age>Âge

Exemple de Get Listings

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>BIN</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>MAKE_OFFER</Type>
      <RegistrationDate>1791875010217</RegistrationDate>
      <ExpirationDate>1791875010217</ExpirationDate>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&currency=usd&command=get_listings&count_per_page=20&page_index=1
Réponse (format JSON)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Total": 2,
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "BIN"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No",
        "RegistrationDate": 1791875010217,
        "ExpirationDate": 1791875010217,
        "Type": "MAKE_OFFER"
      }
    ]
  }
}
 

Commande de récupération d'un élément d'annonce

Prise en charge du multi-thread
API Sandbox non prise en charge

Si vous appelez la commande get listing item, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir un élément d'annonce
Explication
domainLe nom de domaine dont vous voulez obtenir les détails, un seul domaine peut être saisi par requête
currency (optional)La devise du résultat renvoyé, elle doit être "usd", "eur" ou "cny", la devise par défaut est le dollar américain
Balise XML de résultat
Explication
<GetListingItemResponse></GetListingItemResponse>Nœud racine du document XML de réponsedocument XML
<GetListingItemHeader></GetListingItemHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetListingsItemContent></GetListingsItemContent>Contenu de l'annonce
<Listing></Listing>Contenu de l'élément d'annonce
<ListingId></ListingId>ID de l'annonce
<Domain></Domain>Nom de domaine
<Price></Price>Prix
<InBoundLinks></InBoundLinks>Nombre de liens entrants
<Age></Age>Âge

Exemple de récupération d'un élément d'annonce

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
      <Type>BIN</Type>
      <RegistrationDate>1791875010218</RegistrationDate>
      <ExpirationDate>1791875010218</ExpirationDate>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_listing_item&currency=usd&domain=domain_name
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_listing_item&currency=usd&domain=domain_name
Réponse (format JSON)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No",
      "RegistrationDate": 1791875010218,
      "ExpirationDate": 1791875010218,
      "Type": "BIN"
    }
  }
}
 

Commande Acheter maintenant

Prise en charge du multi-thread
API Sandbox non prise en charge

Si vous appelez la commande Acheter maintenant, les paramètres suivants doivent être inclus :

Paramètre de requête Buy It Now
Explication
domainLe domaine que vous souhaitez acheter, un seul domaine peut être saisi par requête
currency (optional)La devise du résultat renvoyé doit être "usd", "eur" ou "cny". Si aucune devise n'est saisie, la devise par défaut du compte sera appliquée.
price_to_verify (optional)Le prix buy_it_now attendu à vérifier avant l'achat. Si le prix de vente réel de l'annonce ne correspond pas à cette valeur, la requête échouera.
Balise XML de résultat
Explication
<BuyItNowResponse></BuyItNowResponse>Nœud racine du document XML de réponsedocument XML
<BuyItNowHeader></BuyItNowHeader>En-tête de réponse
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<Message></Message>Cela doit être "domain order created", utilisé uniquement lorsque le statut est "success".

Exemple d'achat immédiat

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<BuyItNowResponse>
  <BuyItNowHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </BuyItNowHeader>
  <BuyItNowContent>
    <OrderId>1</OrderId>
  </BuyItNowContent>
</BuyItNowResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=buy_it_now&domain=domain&currency=usd&price_to_verify=1234
Réponse (format JSON)
{
  "BuyItNowResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderId": 1
  }
}
 

Commande d'ajout d'un nouveau lead

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande Add New Lead importera vos propres leads dans le système de Dynadot avec un taux de commission de 5%.

Remarque : le domaine sera déverrouillé pour permettre à l'acheteur de finaliser immédiatement sa commande dès l'acceptation.

Cette commande est disponible uniquement aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête d'ajout d'un nouveau lead
Explication
domain_nameLe nom de domaine pour lequel vous souhaitez ajouter un lead, un seul domaine peut être saisi par requête
lead_typele type de lead pour lequel vous voulez définir le lead. Les valeurs acceptées sont "buy_now", "make_offer"
pricele prix que vous souhaitez définir pour le lead
buyer_namele nom des acheteurs
buyer_emaill'adresse e-mail des acheteurs
Balise XML de résultat
Explication
<AddNewLeadResponse></AddNewLeadResponse>le nœud racine de la réponse
<AddNewLeadHeader></AddNewLeadHeader>En-tête d'ajout d'un nouveau lead
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple d'ajout d'un nouveau prospect

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<AddNewLeadResponse>
  <AddNewLeadHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AddNewLeadHeader>
</AddNewLeadResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=add_new_lead&domains=test.com&lead_type=buy_now&price=1000&buyer_name=test_buyer_name&[email protected]
Réponse (format JSON)
{
  "AddNewLeadResponse": {
    "ResponseCode": 0,
    "Status": "success"
  }
}
 

Commande de mise en vente

Prise en charge du multi-thread
API Sandbox non prise en charge

Cette commande prend en charge le multi-thread.

Appeler la commande Set For Sale mettra votre domaine en vente dans la Place de marché des domaines. Cette commande n'est disponible qu'aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête de mise en vente
Explication
domainsLe domaine que vous souhaitez mettre en vente dans la place de marché des domaines, un seul domaine peut être saisi par requête
for_sale_typeVous pouvez choisir une valeur dans la liste suivante pour représenter votre type de vente :
> place de marché:
Mettez votre domaine en vente dans le Marché de domaines. Les nouvelles annonces de domaines seront définies sur la catégorie, la sous-catégorie et le prix saisis ci-dessous. Si un prix réel est défini, le domaine sera disponible à l'achat immédiat et transféré à l'acheteur. Plus d'infos sur le processus de vente de domaine >

> not_for_sale:
annuler l'annonce
listing_type (optional)Vous pouvez choisir une valeur dans la liste suivante pour représenter votre type de vente via le marché : (obligatoire si for_sale_type est marketplace)
> buy_now
Définir un prix fixe rendra le domaine disponible pour un achat immédiat et le poussera vers l'acheteur.
Remarque : Pour un domaine en période de grâce d'ajout, s'il y a une vente, il peut ne plus être supprimé en grâce. Plus d'informations sur Grace Deletion

> make_offer
Vous pouvez choisir de fixer un prix d'offre minimum ou de laisser vide pour permettre tout montant d'offre.
Remarque : Pour un domaine en période de grâce d'ajout, s'il y a une vente, il peut ne plus être supprimé en grâce. Plus d'informations sur Grace Deletion

> buy_now_and_make_offer Définir un prix fixe rendra le domaine disponible à l'achat immédiat et le transférera à l'acheteur.
Vous pouvez choisir de fixer un prix d'offre minimum ou de laisser vide pour permettre tout montant d'offre.
Remarque : Pour un domaine en période de grâce d'ajout, s'il y a une vente, il peut ne plus être supprimé en grâce. Plus d'informations sur Grace Deletion
price (optional)le prix auquel vous voulez vendre votre domaine. (obligatoire si for_sale_type est marketplace)
minimum_offer (optional)l'offre minimale que vous accepterez pour votre domaine. (obligatoire si for_sale_type est marketplace)
installment (optional)Le paiement échelonné est-il autorisé. Si vous souhaitez activer le paiement échelonné, définissez-le sur "Yes"
maximum_installments (optional)Le nombre maximum de versements autorisés, utilisé uniquement lorsque installment est "true"
Vous pouvez choisir une valeur de 2 à 12 pour représenter le nombre maximum de mois pour le paiement échelonné
category (optional)choisissez une catégorie pour votre domaine, vous pouvez vous référer au tableau comparatif des catégories et sous-catégories ci-dessous pour un remplissage facultatif.
Sub-category (optional)choisissez une sous-catégorie pour votre domaine, vous pouvez vous référer au tableau de comparaison des catégories et sous-catégories ci-dessous pour faire votre sélection.
Remarque: la valeur de votre paramètre doit être le numéro correspondant à la sous-catégorie.
CatégorieSous-catégorie
advertisingmarketing
retail
sales
automotivecars_trucks
enthusiasts
motorsports
businessinvestment
law
money
professions
services
careers_educationNo subCategory
consumer_goods_servicesapparel
electronics
entertainmentgames
pop_culture
fashionNo subCategory
financeNo subCategory
gamblingcasino
sports
healthfitness
medicine
internetblogs
ecommerce
domains
web_design
web_hosting
otherNo subCategory
placesafrica
asia
europe
north_america
south_america
real_estateNo subCategory
scienceNo subCategory
societyculture
news
politics
religion
sportsleisure_activities
professional
technologycomputers
uncategorizedNo subCategory
adultNo subCategory
homeNo subCategory
aiNo subCategory
aerospaceNo subCategory
agencyNo subCategory
agriculture_companyNo subCategory
analyticsNo subCategory
alcoholNo subCategory
babies_kidsNo subCategory
biotechNo subCategory
clean_energyNo subCategory
cleaningNo subCategory
communityNo subCategory
construction_organizationNo subCategory
cryptocurrency_blockchainNo subCategory
dating_relationshipNo subCategory
daycareNo subCategory
dentalNo subCategory
droneNo subCategory
e_commerceNo subCategory
food_drinkNo subCategory
furnitureNo subCategory
gamesNo subCategory
insuranceNo subCategory
interior_designNo subCategory
legal_lawNo subCategory
motivationalNo subCategory
manufacturingNo subCategory
marketingNo subCategory
medicalNo subCategory
metaverseNo subCategory
movies_tvNo subCategory
music_audioNo subCategory
news_mediaNo subCategory
nftNo subCategory
outdoorNo subCategory
paymentNo subCategory
petsNo subCategory
politicsNo subCategory
property_managementNo subCategory
recruitment_staffingNo subCategory
servicesNo subCategory
securityNo subCategory
socialNo subCategory
transportationNo subCategory
travelNo subCategory
video_books_magazinesNo subCategory
virtual_realityNo subCategory
website_designNo subCategory
Description (optional)Description de votre domaine
Balise XML de résultat
Explication
<SetForSaleResponse></SetForSaleResponse>le nœud racine de la réponse
<SetForSaleHeader></SetForSaleHeader>Définir l'en-tête À vendre
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de mise en vente

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetForSaleResponse>
  <SetForSaleHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetForSaleHeader>
</SetForSaleResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=set_for_sale&domains=test.com&for_sale_type=marketplace&listing_type=buy_now&price=1000&installment=Yes&category=health&sub_category=fitness&maximum_installments=4&for_sale_type=marketplace&description=testdescription
Réponse (format JSON)
{
  "SetForSaleResponse": {
    "ResponseCode: ": "0",
    "Status": "Success"
  }
}
 

Commande de liste des domaines en transfert sortant

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande de liste des domaines de transfert sortant permettra d'obtenir la liste des domaines en cours de transfert sortant. Cette commande est uniquement disponible au format XML et JSON.Si vous appelez cette commande

Paramètre de requête de la liste des domaines en transfert sortant
Explication
Balise XML de résultat
Explication
<TransferOutDomainListResponse></TransferOutDomainListResponse>le nœud racine de la réponse
<TransferOutDomainListHeader></TransferOutDomainListHeader>En-tête de la liste des domaines en transfert sortant
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<TransferOutDomainListContent></TransferOutDomainListContent>En-tête de la liste des domaines en transfert sortant
<TransferOutDomainList></TransferOutDomainList>La liste des domaines en transfert sortant
<Domain></Domain>Le nom de domaine
<OrderId></OrderId>L'ID de commande du transfert sortant du domaine
<ItemStatus></ItemStatus>Le statut du domaine en transfert sortant

Exemple de liste de domaines de transfert sortant

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=transfer_domain_list
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=transfer_domain_list
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<TransferOutDomainListResponse>
  <TransferOutDomainListHeader>
    <ResponseCode>200</ResponseCode>
    <Status>success</Status>
  </TransferOutDomainListHeader>
  <TransferOutDomainListContent>
    <TransferOutDomainList>
      <TransferOutDomain>
        <OrderId>1</OrderId>
        <Domain>domain1.com</Domain>
        <ItemStatus>Pending</ItemStatus>
      </TransferOutDomain>
    </TransferOutDomainList>
  </TransferOutDomainListContent>
</TransferOutDomainListResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=transfer_domain_list
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=transfer_domain_list
Réponse (format JSON)
{
  "TransferOutDomainListResponse": {
    "ResponseCode": 200,
    "Status": "success",
    "TransferOutDomainList": [
      {
        "orderId": 1,
        "domain": "domain1.com",
        "itemStatus": "Pending"
      }
    ]
  }
}
 

Définir la commande d'action de confirmation Afternic

Prise en charge du multi-thread
API Sandbox non prise en charge

L'appel de la commande Set Afternic Confirm Action définira le domaine pour approuver ou désapprouver le transfert rapide sur Afternic. Cette commande n'est disponible qu'au format XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête Set Afternic Confirm Action
Explication
domainLe domaine pour lequel vous souhaitez définir l'action de confirmation de transfert rapide Afternic, un seul domaine peut être saisi par requête
actionL'action que vous souhaitez définir pour la confirmation afternic, elle doit être "confirm_afternic", ou "delete_from_afternic"
Balise XML de résultat
Explication
<SetAfternicConfirmActionResponse></SetAfternicConfirmActionResponse>Balise de la réponse Set Afternic Confirm Action, c'est le nœud racine du document XML de réponse
<SetAfternicConfirmActionHeader></SetAfternicConfirmActionHeader>Définir l'en-tête de l'action de confirmation Afternic
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de définition de l'action de confirmation Afternic

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetAfternicConfirmActionResponse>
  <SetAfternicConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetAfternicConfirmActionHeader>
</SetAfternicConfirmActionResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_afternic_confirm_action&domain=domain.com&action=confirm_afternic
Réponse (format JSON)
{
  "SetAfternicConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Définir la commande d'action de confirmation Sedo

Prise en charge du multi-thread
API Sandbox non prise en charge

Appeler la commande Set Sedo Confirm Action définira le domaine pour approuver ou refuser le transfert rapide sur Sedo. Cette commande n'est disponible qu'au format XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Définir le paramètre de requête d'action de confirmation Sedo
Explication
domainLe domaine pour lequel vous souhaitez définir l'action Sedo de confirmation de transfert rapide, un seul domaine peut être saisi par requête
actionL'action que vous voulez définir pour la confirmation Sedo, elle doit être "confirm_sedo" ou "delete_from_sedo"
Balise XML de résultat
Explication
<SetSedoConfirmActionResponse></SetSedoConfirmActionResponse>Balise de la réponse Set Sedo Confirm Action, c'est le nœud racine du document XML de réponse
<SetSedoConfirmActionHeader></SetSedoConfirmActionHeader>Définir l'en-tête de l'action de confirmation Sedo
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"

Exemple de Set Sedo Confirm Action

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<SetSedoConfirmActionResponse>
  <SetSedoConfirmActionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetSedoConfirmActionHeader>
</SetSedoConfirmActionResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=set_sedo_confirm_action&domain=domain.com&action=confirm_sedo
Réponse (format JSON)
{
  "SetSedoConfirmActionResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Commande Get Whois Stats

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande Get Whois Stats renvoie les statistiques Whois. Cette commande est disponible uniquement aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête des statistiques Whois
Explication
domain_nameLe nom de domaine pour lequel vous devez configurer DNSSEC
date_typeVous pouvez choisir un champ dans la liste suivante pour représenter votre type de date :
last_7_days, last_30_days, current_year, last_year
Balise XML de résultat
Explication
<GetWhoisStatsResponse></GetWhoisStatsResponse>le nœud racine de la réponse
<GetWhoisStatsHeader></GetWhoisStatsHeader>En-tête des statistiques Whois
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetWhoisStatsContent></GetWhoisStatsContent>contenu de la réponse
<WhoisStats></WhoisStats>Contient plusieurs ensembles de données statistiques whois
<WhoisStat></WhoisStat>Données spécifiques aux statistiques Whois
<Date></Date>Intervalle de temps minimum
<Count></Count>Nombre de Whois dans l'intervalle de temps actuel

Exemple de récupération des statistiques Whois

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetWhoisStatsResponse>
  <GetWhoisStatsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetWhoisStatsHeader>
  <GetWhoisStatsContent>
    <WhoisStats>
      <WhoisStat>
        <Date>2023-11-04</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-05</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-06</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-07</Date>
        <Count>200</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-08</Date>
        <Count>300</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-09</Date>
        <Count>100</Count>
      </WhoisStat>
      <WhoisStat>
        <Date>2023-11-10</Date>
        <Count>200</Count>
      </WhoisStat>
    </WhoisStats>
  </GetWhoisStatsContent>
</GetWhoisStatsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=get_whois_stats&domain_name=domain1.com&date_type=last_7_days
Réponse (format JSON)
{
  "GetWhoisStatsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "WhoisStats": [
      {
        "Date": "2023-11-04",
        "Count": 200
      },
      {
        "Date": "2023-11-05",
        "Count": 300
      },
      {
        "Date": "2023-11-06",
        "Count": 100
      },
      {
        "Date": "2023-11-07",
        "Count": 200
      },
      {
        "Date": "2023-11-08",
        "Count": 300
      },
      {
        "Date": "2023-11-09",
        "Count": 100
      },
      {
        "Date": "2023-11-10",
        "Count": 200
      }
    ]
  }
}
 

Commande de liste des commandes

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

L'appel de la commande Order List permet d'obtenir la liste des commandes. Cette commande n'est disponible qu'au format XML et JSON.Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête de liste de commandes
Explication
search_byVous pouvez choisir une valeur dans la liste suivante pour représenter votre type de recherche : date_range, domain, order_id
start_datela date de début de votre requête au format yyyy/MM/dd
end_datela date de fin de votre requête au format yyyy/MM/dd
payment_methodVous pouvez choisir plusieurs valeurs dans la liste suivante pour représenter votre moyen de paiement :
none_balance
solde_du_compte
credit_card
money_order
Paypal
Moneybooker
virement_bancaire
Alipay
payflow_credit_card2 (N'est plus utilisé)
wechat_pay
ecash
virement_bancaire
apple_pay
checking_account
vente
union_pay
compte_paypal
mercado_pago
Payoneer
mais veuillez utiliser une virgule pour séparer plusieurs valeurs, par exemple : account_balance,credit_card
Balise XML de résultat
Explication
<OrderListResponse></OrderListResponse>le nœud racine de la réponse
<OrderListHeader></OrderListHeader>En-tête de la liste des commandes
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<OrderListContent></OrderListContent>En-tête de la liste des commandes
<OrderList></OrderList>Contient plusieurs ensembles de données du journal des commandes
<OrderItem></OrderItem>Contient les données de journal d'une seule commande
<OrderItemDomain></OrderItemDomain>Le nom de domaine qui inclut les éléments dans cet ordre
<OrderId></OrderId>Contient l'ID de la commande
<SubmittedDate></SubmittedDate>Contient la date à laquelle la commande a été soumise
<Cost></Cost>Contient le coût de la commande
<Status></Status>Contient le statut de la commande

Exemple de liste de commandes

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<OrderListResponse>
  <OrderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </OrderListHeader>
  <OrderListContent>
    <OrderList>
      <Order>
        <OrderId>123456</OrderId>
        <SubmittedDate>1791875010219</SubmittedDate>
        <Currency>USD</Currency>
        <PaymentMethod>Account Balance</PaymentMethod>
        <TotalCost>$8.00</TotalCost>
        <TotalPaid>$8.00</TotalPaid>
        <Status>Problem</Status>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test.com</Name>
          <Duration>1</Duration>
          <Cost>2.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test1.ac</Name>
          <Duration>1</Duration>
          <Cost>3.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test2.de</Name>
          <Duration>1</Duration>
          <Cost>4.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Registration</ItemType>
          <Name>test3.gg</Name>
          <Duration>1</Duration>
          <Cost>5.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Renewal</ItemType>
          <Name>test4.uk</Name>
          <Duration>1</Duration>
          <Cost>6.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
        <OrderItem>
          <ItemType>Domain Transfer</ItemType>
          <Name>test5.net</Name>
          <Duration>1</Duration>
          <Cost>7.99</Cost>
          <Status>Completed</Status>
        </OrderItem>
      </Order>
      <Order>
        <OrderId>123457</OrderId>
        <SubmittedDate>1791875010219</SubmittedDate>
        <Currency>EUR</Currency>
        <PaymentMethod>Paypal</PaymentMethod>
        <TotalCost>$100.00</TotalCost>
        <TotalPaid>$100.00</TotalPaid>
        <Status>Submitted</Status>
      </Order>
    </OrderList>
  </OrderListContent>
</OrderListResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=order_list&search_by=date_range&start_date=2024/01/01&end_date=2024/01/31&payment_method=account_balance,credit_card
Réponse (format JSON)
{
  "OrderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderList": [
      {
        "OrderId": "123456",
        "SubmittedDate": "2026/10/13",
        "Currency": "USD",
        "PaymentMethod": "Account Balance",
        "TotalCost": "$8.00",
        "TotalPaid": "$8.00",
        "Status": "Problem",
        "ItemList": [
          {
            "ItemType": "Domain Registration",
            "Name": "test.com",
            "Duration": 1,
            "Cost": "2.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test1.ac",
            "Duration": 1,
            "Cost": "3.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test2.de",
            "Duration": 1,
            "Cost": "4.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Registration",
            "Name": "test3.gg",
            "Duration": 1,
            "Cost": "5.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Renewal",
            "Name": "test4.uk",
            "Duration": 1,
            "Cost": "6.99",
            "Status": "Completed"
          },
          {
            "ItemType": "Domain Transfer",
            "Name": "test5.net",
            "Duration": 1,
            "Cost": "7.99",
            "Status": "Completed"
          }
        ]
      },
      {
        "OrderId": "123457",
        "SubmittedDate": "2026/10/13",
        "Currency": "EUR",
        "PaymentMethod": "Paypal",
        "TotalCost": "$100.00",
        "TotalPaid": "$100.00",
        "Status": "Submitted",
        "ItemList": []
      }
    ]
  }
}
 

Commande de récupération du statut de commande

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

L'appel de la commande Get Order Status Command permet d'obtenir le statut de la commande. Cette commande n'est disponible qu'aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus :

Paramètre de requête pour obtenir le statut de la commande
Explication
order_idL'identifiant de la commande à interroger
Balise XML de résultat
Explication
<GetOrderStatusResponse></GetOrderStatusResponse>le nœud racine de la réponse
<GetOrderStatusHeader></GetOrderStatusHeader>Obtenir l'en-tête du statut de la commande
<ResponseCode></ResponseCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<GetOrderStatusContent></GetOrderStatusContent>contenu de la réponse
<OrderId></OrderId>ID de commande
<OrderStatus></OrderStatus>statut de la commande( Shopping, Submitted, Waitpay, Processing, Completed, Problem, Deleted, Cancelled )
<ItemTypeName></ItemTypeName>Type d'élément
<ItemName></ItemName>Nom de l'élément
<ItemStatus></ItemStatus>Statut de l'article(Terminé, Annulé, Problème)

Exemple de Get Order Status

Demande (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Requête Sandbox (format XML)https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_order_status&order_id=0
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Requête Sandbox (format JSON)https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_order_status&order_id=0
Réponse (format JSON)
{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}
 

Commande de vérification du traitement

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande is_processing vous indiquera s'il est sûr de soumettre une nouvelle requête

Paramètre de requête Is-Processing
Explication
aucun paramètre supplémentaire n'est nécessaire
Balise XML de résultat
Explication
<Response></Response>Balise de la réponse is_processing
<ResponseHeader></ResponseHeader>Balise de l'en-tête is_processing
<ResponseMsg></ResponseMsg>Tag of is_processing response message. It should be "yes"(There is a process in the system. You shouldn't sent another request.) or "no"(There is no any process for you account. It is safe to submit a new request.)

Exemple de vérification de traitement

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=is_processing
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=is_processing
Réponse (format XML)
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=is_processing
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=is_processing
Réponse (format JSON)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
Demande (format CSV)https://api.dynadot.com/api3.html?key=[API Key]&command=is_processing
Requête Sandbox (format CSV)https://api-sandbox.dynadot.com/api3.html?key=[Sandbox API Key]&command=is_processing
Réponse (format CSV)
ok,yes
 

Commande de liste des coupons

Prise en charge du multi-thread
Prise en charge de l'API Sandbox

Appeler la commande List Coupons récupérera tous les coupons. Cette commande est uniquement disponible aux formats XML et JSON. Si vous appelez cette commande, les paramètres suivants doivent être inclus:

Paramètre de requête pour lister les coupons
Explication
coupon_typeVous pouvez choisir une valeur dans la liste suivante pour représenter votre type de recherche : "registration" , "renewal" , ou "transfer"
Balise XML de résultat
Explication
<ListCouponsResponse></ListCouponsResponse>le nœud racine de la réponse
<ListCouponsHeader></ListCouponsHeader>En-tête de liste des coupons
<SuccessCode></SuccessCode>Si l'opération réussit, "0" pour un succès, "-1" pour un échec
<Status></Status>Le statut de la requête
<Error></Error>Informations d'erreur concernant la requête, utilisées uniquement lorsque le statut est "error"
<ListCouponsContent></ListCouponsContent>Contenu de la liste des coupons
<Coupons></Coupons>Contient plusieurs ensembles de données de coupon
<Coupon></Coupon>Contient les données d'un seul coupon
<Code></Code>Code promo
<Description></Description>Description du coupon
<CouponType></CouponType>Type de coupon
<DiscountType></DiscountType>Type de réduction offerte par le coupon
<DiscountInfo></DiscountInfo>Les informations de réduction du coupon
<Percentage></Percentage>Le pourcentage de la remise
<AUD></AUD>Montant de la remise en dollars australiens
<MXN></MXN>Montant de la remise en pesos mexicains
<EUR></EUR>Montant de la remise en euros
<GBP></GBP>Montant de la réduction en livres sterling
<IDR></IDR>Montant de la remise en roupies indonésiennes
<USD></USD>Montant de la remise en dollars américains
<CAD></CAD>Montant de la remise en dollars canadiens
<INR></INR>Montant de la remise en roupies indiennes
<BRL></BRL>Montant de la réduction en real brésilien
<CNY></CNY>Montant de la remise en yuan chinois
<Restriction></Restriction>Restrictions de coupon
<PriceLevels></PriceLevels>Une collection de niveaux de prix qui prennent en charge l'utilisation de coupons
<UsesPerAccount></UsesPerAccount>Le nombre de fois que le coupon peut être utilisé par compte
<UsesSystemWide></UsesSystemWide>Le nombre de fois que le coupon peut être utilisé sur l'ensemble du système
<UsesPerIp></UsesPerIp>Le nombre de fois que le coupon peut être utilisé par adresse IP
<ItemsPerAccount></ItemsPerAccount>Le nombre d'articles pour lesquels le coupon peut être utilisé par compte
<ItemsSystemWide></ItemsSystemWide>Le nombre d'articles pour lesquels le coupon peut être utilisé à l'échelle du système
<ItemsPerOrder></ItemsPerOrder>Le nombre d'articles pour lesquels le coupon peut être utilisé par commande
<ItemsPerDay></ItemsPerDay>Le nombre d'articles pour lesquels le coupon peut être utilisé par jour
<IdnRestriction></IdnRestriction>Restrictions IDN pour le coupon
<DomainDurationMin></DomainDurationMin>Durée minimale du domaine
<DomainDurationMax></DomainDurationMax>Durée maximale d'enregistrement du domaine
<Tlds></Tlds>Une collection de domaines de premier niveau qui prennent en charge l'utilisation de coupons
<Tld></Tld>Un seul domaine de premier niveau qui prend en charge l'utilisation de coupons
<Currencies></Currencies>Un ensemble de types de devises qui prennent en charge l'utilisation de coupons
<Currency></Currency>Un type de devise unique qui prend en charge l'utilisation de coupons
<StartDate></StartDate>La date de début de validité du coupon
<EndDate></EndDate>La date de fin de validité du coupon

Exemple de liste de coupons

Demande (format XML)https://api.dynadot.com/api3.xml?key=[API Key]&command=list_coupons&coupon_type=renewal
Requête Sandbox (format XML)https://api-sandbox.dynadot.com/api3.xml?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
Réponse (format XML)
<?xml version="1.0" encoding="UTF-8"?>
<ListCouponsResponse>
  <ListCouponsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </ListCouponsHeader>
  <ListCouponsContent>
    <Coupons>
      <Coupon>
        <Code>DOMAINRENEW1</Code>
        <Description>Domain Renew Coupon</Description>
        <CouponType>Hosting/SSL Coupons</CouponType>
        <DiscountType>PERCENTAGE_OFF</DiscountType>
        <DiscountInfo>
          <Percentage>10%</Percentage>
        </DiscountInfo>
        <Restriction>
          <PriceLevels>Any</PriceLevels>
          <IdnRestriction>None</IdnRestriction>
          <DomainDurationMin>1</DomainDurationMin>
          <DomainDurationMax>1</DomainDurationMax>
          <Tlds>
            <Tld>.com</Tld>
            <Tld>.net</Tld>
            <Tld>.org</Tld>
          </Tlds>
          <Currencies>
            <Currency>US Dollar USD ($)</Currency>
          </Currencies>
        </Restriction>
        <StartDate>1476811260000</StartDate>
        <EndDate>1483257540000</EndDate>
      </Coupon>
    </Coupons>
  </ListCouponsContent>
</ListCouponsResponse>
Demande (format JSON)https://api.dynadot.com/api3.json?key=[API Key]&command=list_coupons&coupon_type=renewal
Requête Sandbox (format JSON)https://api-sandbox.dynadot.com/api3.json?key=[Sandbox API Key]&command=list_coupons&coupon_type=renewal
Réponse (format JSON)
{
  "ListCouponsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Coupons": [
      {
        "Code": "DOMAINRENEW1",
        "Description": "Domain Renew Coupon",
        "CouponType": "Hosting/SSL Coupons",
        "DiscountType": "PERCENTAGE_OFF",
        "DiscountInfo": {
          "Percentage": "10%"
        },
        "Restriction": {
          "PriceLevels": "Any",
          "IdnRestriction": "None",
          "DomainDurationMin": "1",
          "DomainDurationMax": "1",
          "Tlds": [
            ".com",
            ".net",
            ".org"
          ],
          "Currencies": [
            "US Dollar USD ($)"
          ]
        },
        "StartDate": "1476811260000",
        "EndDate": "1483257540000"
      }
    ]
  }
}
津ICP备2023009172号-6