Empezando con nuestro Dominio API avanzado
Requests to our Advanced Domain API are sent to the following URL:
https://api.dynadot.com/api3.xml
Tenga en cuenta que las solicitudes deben ser enviadas a través de https (conexión segura) por seguridad. Sólo se puede procesar 1 solicitud a la vez, así que por favor espere a que su solicitud actual culmine antes de enviar otra solicitud. La solicitud debe tener los siguientes parámetros:
Request ParameterExplicación
Request Parameter
Explicación
KeyTu clave para acceder el API, disponible en tu panel de control en tu cuenta
Command, , , , , ,
, , , , , , , , , , , , , , , ,
, , , , , ,
, , , , , ,
, , , , , , ,
, ,
, , , , , , , , , , , ,
, , , , , , , , , , , , , ,
, ,
, , , ,
, , , , , ,
Our Advanced Domain API will return results in an XML format. The response you receive should contain 2 or 3 of the following fields:
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Orden de búsqueda
Si estás llamando la orden de búsqueda, hay que incluir los siguientes parámetros:
Parámetro de la petición de búsquedaExplicación
Parámetro de la petición de búsqueda
Explicación
domain0 - domain99El nombre de dominio que está buscando, la cuenta normal puede especificar 1 dominio por comando, la cuenta masiva y súper masiva puede especificar hasta 100 dominios
language0 - language99 (opcional)La etiqueta del idioma para el dominio, sólo se usa para los dominios internacionales
show_price (opcional)Si desea mostrar el precio en la moneda de su cuenta, configúrelo igual a "1".
currency (opcional)Puede decidir el tipo de moneda y las opciones admitidas para este parámetro son "USD", "CNY", "GBP", "EUR", "INR", "CAD", etc. Si no se especifica este parámetro, usaremos la moneda predeterminada de la cuenta
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<Results></Results>El nodo raíz de la respuesta XML del comando de búsqueda
<SearchResponse></SearchResponse>Etiqueta del resultado de la búsqueda
<SearchHeader></SearchHeader>Etiqueta del titulo de búsqueda
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<DomainName></DomainName>El nombre de dominio que acabas de buscar
<Available></Available>Si el dominio está disponible
<Price></Price>Si configura "show_price" (mostrar precio) igual a "1", esto le indicará la información de precio si este dominio está disponible.
<Language></Language>Información del idioma del nombre de dominio
Ejemplo de búsqueda
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1¤cy=USD
Response (XML format)
<Results>
<SearchResponse>
<SearchHeader>
<SuccessCode>0</SuccessCode>
<DomainName>mydomain.com</DomainName>
<Available>yes</Available>
<Price>77.00 in USD</Price>
</SearchHeader>
</SearchResponse>
<SearchResponse>
<SearchHeader>
<SuccessCode>0</SuccessCode>
<DomainName>mydomain.net</DomainName>
<Available>yes</Available>
<Price>44.00 in USD</Price>
</SearchHeader>
</SearchResponse>
</Results>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1¤cy=USD
Response (JSON format)
{
"SearchResponse":{
"ResponseCode":"0",
"SearchResults":[
{
"DomainName":"mydomain.com",
"Available":"yes",
"Price":"77.00 in USD"
},
{
"DomainName":"mydomain.net",
"Available":"yes",
"Price":"44.00 in USD"
}
]
}
}
Orden de registro
Llamar la orden de registro crea y procesa una orden de registro. Hay que tener suficiente saldo de cuenta para pagar la orden. Si estás llamando la orden de registro, hay que incluir los siguientes parámetros:
Parámetro de orden de registroExplicación
Parámetro de orden de registro
Explicación
domainEl dominio que deseas registrar, sólo se puede registrar 1 dominio a la vez por solicitud
language (opcional)La etiqueta de idioma para el dominio solicitado, sólo se necesita si el dominio sea internacional
durationPara cuánto tiempo deseas registrar el dominio
registrant_contact (opcional)The registrant contact you want to use on the domain
admin_contact (opcional)The admin contact you want to use on the domain
technical_contact (opcional)The technical contact you want to use on the domain
billing_contact (opcional)The billing contact you want to use on the domain
option0 (si es necesario)
El nombre del registrante .AT, .BE,
option1 (si es necesario)The .AT, .BE, registrant organization (optional)
Para .AT, puede especificar option0, option1, o ambos
premium (opcional)Si quiere registrar un dominio premium, configúrelo como "1" (opcional)
currency (opcional)Puede decidir el tipo de moneda y las opciones admitidas para este parámetro son "USD", "CNY", "GBP", "EUR", "INR", "CAD", etc. Si no se especifica este parámetro, usaremos la moneda predeterminada de la cuenta
coupon (opcional)El código de cupón que desea aplicar a este comando
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<RegisterResponse></RegisterResponse>Etiqueta de la respuesta del registro
<RegisterHeader></RegisterHeader>Etiqueta del titulo del registro
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<RegisterContent></RegisterContent>Etiqueta del contenido del registro
<Expiration></Expiration>Fecha de caducidad en tiempo Unix (milisegundos desde la medianoche UTC de enero 1, 1970), sólo se utiliza cuando el resultado es "success"
<Registration></Registration>Fecha de registro en tiempo Unix (milisegundos desde la medianoche UTC de enero 1, 1970), sólo se utiliza cuando el resultado es "success"
Ejemplo de registro
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=register&domain=domain1.net&duration=3¤cy=USD
Response (XML format)
<RegisterResponse>
<RegisterHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</RegisterHeader>
<RegisterContent>
<Expiration>1458379145266</Expiration>
</RegisterContent>
</RegisterResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=register&domain=domain1.net&duration=3¤cy=USD
Response (JSON format)
{
"RegisterResponse":{
"ResponseCode":"0",
"Status":"success",
"DomainName":"domain1.net",
"Expiration":"1458379145266"
}
}
Orden de eliminación
Al llamar al comando de eliminación, se eliminará un dominio que aún se encuentre en el período de gracia. Se acreditará al saldo de su cuenta la cuota de inscripción. Los dominios que se han renovado o que se han trasladado a una nueva cuenta no se pueden eliminar a través de la API. Si llama al comando de eliminación, se deben incluir los siguientes parámetros:
Parámetro de orden de eliminaciónExplicación
Parámetro de orden de eliminación
Explicación
domainEl dominio que deseas eliminar, sólo se puede eliminar 1 dominio a la vez por solicitud
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DeleteResponse></DeleteResponse>Etiqueta de la respuesta de eliminación
<DeleteHeader></DeleteHeader>Etiqueta del titulo de eliminación
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de eliminación
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=delete&domain=domain1.com
Response (XML format)
<DeleteResponse>
<DeleteHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</DeleteHeader>
</DeleteResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=delete&domain=domain1.com
Response (JSON format)
{
"DeleteResponse":{
"ResponseCode":"0",
"Status":"success",
"DomainName":"domain1.com",
}
}
Orden de renovación
Al llamar al comando renovar, se creará y procesará una orden de renovación. Debe tener saldo suficiente en la cuenta para pagar el pedido. Si llama al comando renovar (renew), se deben incluir los siguientes parámetros:
Parámetro de orden de renovaciónExplicación
Parámetro de orden de renovación
Explicación
domainEl dominio que deseas renovar, sólo se puede renovar 1 a la vez por solicitud
durationPara cuántos años deseas renovar el dominio
year (opcional)El actual año en el que se expira el dominio
currency (opcional)Puede decidir el tipo de moneda y las opciones admitidas para este parámetro son "USD", "CNY", "GBP", "EUR", "INR", "CAD", etc. Si no se especifica este parámetro, usaremos la moneda predeterminada de la cuenta
price_check (opcional)Puede añadir este parámetro al comando para verificar el precio detallado para la renovación este dominio. NOTA: Añadiendo este parámetro al comando, nuestra api no renovará el dominio, sino que sólo mostrará la información del precio.
coupon (opcional)El código de cupón que desea aplicar a este comando
no_renew_if_late_renew_fee_needed (opcional)You can add this parameter to the command to avoid the renewal if the domain requires late renewal fee. If domain does requires late renew fee to renew, and "no_renew_if_late_renew_fee_needed = 1" was passed in command, domain will not be renewed.
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<RenewResponse></RenewResponse>Etiqueta de respuesta de renovación, es el nodo raíz del documento de respuesta XML
<RenewHeader></RenewHeader>Titulo de la renovación
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<PriceInfo></PriceInfo>Etiqueta de información de precios, sólo se utiliza cuando el estado es "price_check_success"
<RenewContent></RenewContent>Etiqueta de contenido de renovación, sólo se utiliza cuando el estado es "success"
<Expiration></Expiration>Fecha de caducidad en tiempo Unix (milisegundos desde la medianoche UTC de enero 1, 1970), sólo se utiliza cuando el resultado es "success"
Ejemplo de renovación
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&domain=domian1.com&command=renew&duration=1¤cy=USD&coupon=testcoupon
Response (XML format)
<RenewResponse>
<RenewHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</RenewHeader>
<RenewContent>
<Expiration>73984579834</Expiration>
</RenewContent>
</RenewResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&domain=domian1.com&command=renew&duration=1¤cy=USD&coupon=testcoupon
Response (JSON format)
{
"RenewResponse":{
"ResponseCode":"0",
"Status":"success",
"DomainName":"domian1.com",
"Expiration":"73984579834"
}
}
Push Command
La ejecución del comando push creará y procesará una orden push. Debe desbloquear su dominio y su cuenta para la solicitud. La cuenta del receptor debe rechazar/aceptar el dominio para completar la orden. Si se ejecuta el comando push, se deben incluir los siguientes parámetros:
Parámetro de Solicitud PushExplicación
Parámetro de Solicitud Push
Explicación
domainEl nombre del dominio que desea enviar. También soportamos el envío masivo, puede utilizar ";" para separar los dominios. Ejemplo: dominio1.com;dominio2.com
receiver_push_usernamePush Username of receiver account
currency (opcional)Puede decidir el tipo de moneda y las opciones admitidas para este parámetro son "USD", "CNY", "GBP", "EUR", "INR", "CAD", etc. Si no se especifica este parámetro, usaremos la moneda predeterminada de la cuenta
unlock_domain_for_push(optional)Configure este parámetro igual a "1". Si el dominio está bloqueado, lo desbloquearemos automáticamente, para que no tenga que desbloquearlo manualmente
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<PushResponse></PushResponse>Etiqueta de la respuesta push, es el nodo raíz del documento de respuesta XML
<PushHeader></PushHeader>Título de operación Push
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Push
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=push&domain=domian1.com&receiver_push_username=username¤cy=USD
Response (XML format)
<PushResponse>
<PushHeader>
<SuccessCode>0</SuccessCode>
<Status>order created</Status>
</PushHeader>
</PushResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=push&domain=domian1.com&receiver_push_username=username¤cy=USD
Response (JSON format)
{
"PushResponse":{
"ResponseCode":"0",
"Status":"order created"
}
}
Comando de transferencia
La ejecución del comando de transferencia creará y procesará una orden de transferencia. Algunos tlds pueden requerir perder al registrador para confirmar y completar la orden. Si se ejecuta al comando de transferencia, se deben incluir los siguientes parámetros:
Parámetro de Solicitud de TransferenciaExplicación
Parámetro de Solicitud de Transferencia
Explicación
domainEl nombre de dominio que desea transferir a Dynadot, sólo el dominio 1 puede ser transferido mediante solicitud
authEl código de autorización para la solicitud de transferencia.
currency (opcional)Puede decidir el tipo de moneda y las opciones admitidas para este parámetro son "USD", "CNY", "GBP", "EUR", "INR", "CAD", etc. Si no se especifica este parámetro, usaremos la moneda predeterminada de la cuenta
registrant_contact (opcional)El contacto del registrante que desea utilizar cuando se complete la transferencia. (No todos los tld admiten esta función)
admin_contact (opcional)El contacto de administrador que desea utilizar cuando se complete la transferencia. (No todos los tld admiten esta función)
technical_contact (opcional)El contacto técnico que desea utilizar cuando se complete la transferencia. (No todos los tld admiten esta función)
billing_contact (opcional)El contacto de facturación que desea utilizar cuando se complete la transferencia. (No todos los tld admiten esta función)
coupon (opcional)El código de cupón que desea aplicar a este comando
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<TransferResponse></TransferResponse>Etiqueta de respuesta de transferencia, es el nodo raíz del documento de respuesta XML
<TransferHeader></TransferHeader>Título de transferencia
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Transferencia
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=transfer&domain=domian1.com&auth=testauth¤cy=USD&coupon=testcoupon
Response (XML format)
<TransferResponse>
<TransferHeader>
<SuccessCode>0</SuccessCode>
<Status>order created</Status>
</TransferHeader>
</TransferResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=transfer&domain=domian1.com&auth=testauth¤cy=USD&coupon=testcoupon
Response (JSON format)
{
"TransferResponse":{
"ResponseCode":"0",
"Status":"order created",
"DomainName":"domian1.com"
}
}
Bulk Register Command
Calling the bulk register command will create and process registration orders. You must have enough account balance to pay for the orders. If calling the bulk register command, the following parameters should be included:
Bulk Register Request ParameterExplicación
Bulk Register Request Parameter
Explicación
domain0-domain99The domain name(s) you want to register, maximum 100 domains can be registered per request
premium (opcional)Si quiere registrar un dominio premium, configúrelo como "1" (opcional)
currency (opcional)You can decide the currency type and this parameter supported are "USD","CNY", "GBP","EUR","INR","CAD" and so on. If you missed this parameter,we will use the account default currency
coupon (opcional)El código de cupón que desea aplicar a este comando
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<BulkRegisterResponse></BulkRegisterResponse>Tag of bulk register response
<BulkRegisterHeader></BulkRegisterHeader>Tag of bulk register header
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<BulkRegisterContent></BulkRegisterContent>The tag of bulk register content
<Expiration></Expiration>Fecha de caducidad en tiempo Unix (milisegundos desde la medianoche UTC de enero 1, 1970), sólo se utiliza cuando el resultado es "success"
<Result></Result>The result of the register action
<Message></Message>Error message of register action, only used when result is "error"
Bulk Register Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=bulk_register&domain0=domain0.com&domain1=domain1.com¤cy=USD
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
<BulkRegisterHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</BulkRegisterHeader>
<BulkRegisterContent>
<BulkRegister>
<RegisterResult>
<DomainName>domain0.com</DomainName>
<Expiration>1234567890</Expiration>
<Result>success</Result>
<Message>-</Message>
</RegisterResult>
<RegisterResult>
<DomainName>domain1.com</DomainName>
<Expiration>-</Expiration>
<Result>error</Result>
<Message>not_available</Message>
</RegisterResult>
</BulkRegister>
</BulkRegisterContent>
</BulkRegisterResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=bulk_register&domain0=domain0.com&domain1=domain1.com¤cy=USD
Response (JSON format)
{
"BulkRegisterResponse": {
"ResponseCode": 0,
"Status": "success",
"BulkRegister": [
{
"DomainName": "domain0.com",
"Expiration": "1234567890",
"Result": "success",
"Message": "-"
},
{
"DomainName": "domain1.com",
"Expiration": "-",
"Result": "error",
"Message": "not_available"
}
]
}
}
Orden de información de dominio
This command is only available in XML and JSON format:
Parámetro de orden de información de dominioExplicación
Parámetro de orden de información de dominio
Explicación
domainSólo se permite 1 dominio por solicitud
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DomainInfoResponse></DomainInfoResponse>Nodo raíz del documento de respuesta XML
<DomainInfoResponseHeader></DomainInfoResponseHeader>Titulo de respuesta
<ResponseCode></ResponseCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<DomainInfoContent></DomainInfoContent>Contenido de respuesta
<Domain></Domain>Dominio
<Name></Name>Nombre del dominio
<Expiration></Expiration>Fecha de caducidad de dominio en tiempo Unix (milisegundos desde la medianoche UTC de enero 1, 1970)
<Registration></Registration>Fecha de registro del dominio en tiempo Unix (milisegundos desde la medianoche UTC de 1, 1970 de enero)
<NameServerSettings></NameServerSettings>Configuración de servidor de nombres de dominio
<Type></Type>Tipo de servidor de nombres de dominio
<WithAds></WithAds>Si deseas tener una página de estacionamiento para tu dominio
<Whois></Whois>Información Whois
<Registrant></Registrant>Información del registrante
<ContactId></ContactId>Idenentificación de contacto
<Admin></Admin>Información de administración
<Technical></Technical>Información técnica
<Billing></Billing>Información de facturación
<Locked></Locked>Bloqueado o no
<Disabled></Disabled>Estatus de permisión
<UdrpLocked></UdrpLocked>UDRP (Política de Resolución de Disputas de Nombres de Dominio Uniformes) bloqueo o no
<UdrpLocked></UdrpLocked>UDRP (Política de Resolución de Disputas de Nombres de Dominio Uniformes) bloqueo o no
<RegistrantUnverified></RegistrantUnverified>Registrante no-verificado
<Hold></Hold>En espera
<Privacy></Privacy>Estatus de privacidad
<isForSale></isForSale>Estatus de liquidación
<RenewOption></RenewOption>Opción de renovación
<Note></Note>Notas
<Folder></Folder>Información de carpeta
<FolderId></FolderId>ID de Carpeta
<FolderName></FolderName>Nombre de carpeta
Ejemplo de Información de Dominio
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=domain_info&domain=domain1.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
<DomainInfoHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</DomainInfoHeader>
<DomainInfoContent>
<Domain>
<Name>domain1.com</Name>
<Expiration>1361430589062</Expiration>
<Registration>1234567890123</Registration>
<NameServerSettings>
<Type>Dynadot Parking</Type>
<WithAds>Yes</WithAds>
</NameServerSettings>
<Whois>
<Registrant>
<ContactId>0</ContactId>
</Registrant>
<Admin>
<ContactId>0</ContactId>
</Admin>
<Technical>
<ContactId>0</ContactId>
</Technical>
<Billing>
<ContactId>0</ContactId>
</Billing>
</Whois>
<Locked>yes</Locked>
<Disabled>no</Disabled>
<UdrpLocked>no</UdrpLocked>
<RegistrantUnverified>no</RegistrantUnverified>
<Hold>no</Hold>
<Privacy>none</Privacy>
<isForSale>yes</isForSale>
<RenewOption>no renew option</RenewOption>
<Note/>
<Folder>
<FolderId>-1</FolderId>
<FolderName>(no folder)</FolderName>
</Folder>
</Domain>
</DomainInfoContent>
</DomainInfoResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=domain_info&domain=domain1.com
Response (JSON format)
{
"DomainInfoResponse": {
"ResponseCode": 0,
"Status": "success",
"DomainInfo": {
"Name": "domain1.com",
"Expiration": "1361430589062",
"Registration": "1234567890123",
"NameServerSettings": {
"Type": "Dynadot Parking",
"WithAds": "Yes"
},
"Whois": {
"Registrant": {
"ContactId": "0"
},
"Admin": {
"ContactId": "0"
},
"Technical": {
"ContactId": "0"
},
"Billing": {
"ContactId": "0"
}
},
"Locked": "yes",
"Disabled": "no",
"UdrpLocked": "no",
"RegistrantUnverified": "no",
"Hold": "no",
"Privacy": "none",
"isForSale": "yes",
"RenewOption": "no renew option",
"Note": "",
"Folder": {
"FolderId": "-1",
"FolderName": "(no folder)"
}
}
}
}
Orden de asignar Whois
Si invoca el comando establecer Whois, se debe incluir los siguientes parámetros:
Parámetro de orden de asignar whoisExplicación
Parámetro de orden de asignar whois
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
registrant_contactInformación del registrante del dominio
admin_contactInformación del administrador del dominio
technical_contactInformación técnica del dominio
billing_contactInformación de facturación del dominio
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetWhoisResponse></SetWhoisResponse>Nodo raíz del documento de respuesta XML
<SetWhoisHeader></SetWhoisHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar whois
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_whois&domain=domain4.com®istrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (XML format)
<SetWhoisResponse>
<SetWhoisHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetWhoisHeader>
</SetWhoisResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_whois&domain=domain4.com®istrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (JSON format)
{
"SetWhoisResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de cambiar servidores de nombre
Si estás llamando la orden de cambiar servidores de nombre, hay que incluir los siguientes parámetros:
Parámetro de orden de cambiar servidores de nombreExplicación
Parámetro de orden de cambiar servidores de nombre
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
ns0 - ns12Los servidores de nombres para establecer su dominio a utilizar, puede especificar un máximo de 13 servidores de nombres, pero estos ya deben estar en su cuenta
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetNsResponse></SetNsResponse>Etiqueta de la respuesta establecer servidor de nombres, es el nodo raíz del documento de respuesta XML
<SetNsHeader></SetNsHeader>Etiqueta de encabezado de respuesta de establecer servidor de nombres
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Establecer Servidor de Nombres
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Response (XML format)
<SetNsResponse>
<SetNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetNsHeader>
</SetNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com
Response (JSON format)
{
"SetNsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar estacionamiento
Si estás llamando la orden de asignar estacionamiento, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar estacionamientoExplicación
Parámetro de orden de asignar estacionamiento
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
with_ads (opcional)Si no desea anuncios de terceros, puede utilizar este parámetro con "no"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetParkingResponse></SetParkingResponse>Etiqueta de respuesta establecer parking. Es el nodo raíz del documento de respuesta XML
<SetParkingHeader></SetParkingHeader>Titulo de carpeta de estacionamiento actual
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar estacionamiento
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_parking&domain=domain1.com&with_ads=no
Response (XML format)
<SetParkingResponse>
<SetParkingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetParkingHeader>
</SetParkingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_parking&domain=domain1.com&with_ads=no
Response (JSON format)
{
"SetParkingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar reenvío
Si estás llamando la orden de asignar reenvío, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar reenvíoExplicación
Parámetro de orden de asignar reenvío
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
forward_urlLa URL a la que desea que se redireccione su dominio. Tenga en cuenta que el parámetro debe estar codificado para que la llamada a la API se interprete correctamente. is_temp (opcional)Estado de redireccionamiento de su dominio que desea, el valor por defecto es "temporary", si desea un redireccionamiento permanente, utilice este parámetro con "no"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetForwardingResponse></SetForwardingResponse>Nodo raíz del documento de respuesta XML
<SetForwardingHeader></SetForwardingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar reenvío
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com
Response (XML format)
<SetForwardingResponse>
<SetForwardingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetForwardingHeader>
</SetForwardingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com
Response (JSON format)
{
"SetForwardingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar sigilo
Si estás llamando la orden de asignar sigilo, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar sigiloExplicación
Parámetro de orden de asignar sigilo
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
stealth_urlLa URL a la que desea que se redireccione su dominio. Tenga en cuenta que el parámetro debe estar codificado para que la llamada a la API se interprete correctamente. stealth_title (opcional)El titulo de la página
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetStealthResponse></SetStealthResponse>Nodo raíz del documento de respuesta XML
<SetStealthHeader></SetStealthHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar sigilo
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com
Response (XML format)
<SetStealthResponse>
<SetStealthHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetStealthHeader>
</SetStealthResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com
Response (JSON format)
{
"SetStealthResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar hosting
Si estás llamando la orden de asignar hosting, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar hostingExplicación
Parámetro de orden de asignar hosting
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
hosting_typeTipo de alojamiento que desea, puede seleccionar "advanced" y "basic"
mobile_view_onSolo cuando "hosting_type" (tipo de alojamiento) sea "advanced", puede utilizar este parámetro como "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetHostingResponse></SetHostingResponse>Nodo raíz del documento de respuesta XML
<SetHostingHeader></SetHostingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar hosting
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Response (XML format)
<SetHostingResponse>
<SetHostingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetHostingHeader>
</SetHostingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes
Response (JSON format)
{
"SetHostingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar DNS
Si estás llamando la orden de asignar DNS, hay que incluir los siguientes parámetros:
(Este comando no está actualizado y no es recomendado, utilice, en su lugar, el comando Configurar DNS2)
Parámetro de orden de asignar DNSExplicación
Parámetro de orden de asignar DNS
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
main_record_typetipo de registro principal
main_recordEspecifica un registro DNS para tu dominio
main_txt1 - main_txt4 (opcional)Especificar un registro TXT para su dominio. Si su main_record_type (tipo de registro principal) está en formato aaaa y se especifica un main_record2, se puede establecer hasta 3 main_txts, de lo contrario, puede configurar hasta 4 main_txts (4 textos principales).
main_record2Main record 2 (registro principal 2), sólo se utiliza cuando "main_record_type" es "aaaa". Su valor debe estar en formato ipv4.
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Tipo de registro de subdominio
sub_record0 - sub_record99 (opcional)Dirección IP o host de destino
mx_host0 - mx_host4 (opcional)Especificar el host de correo electrónico para su dominio, distance0 es la prioridad más alta.
mx_distance0 - mx_distance4 (opcional)Distance0 es la prioridad más alta
ttl (opcional)Tiempo de vida
add_dns_to_current_setting (opcional)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDnsResponse></SetDnsResponse>Nodo raíz del documento de respuesta XML
<SetDnsHeader></SetDnsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar DNS
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_dns&domain=domain1.com&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
<SetDnsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDnsHeader>
</SetDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_dns&domain=domain1.com&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (JSON format)
{
"SetDnsResponse": {
"ResponseCode": "0",
"Status": "success"
}
}
Establecer el comando DNS2
Si llama al comando configurar DNS2, se deben incluir los siguientes parámetros:
Tenga en cuenta que llamar al comando set DNS2 anulará la configuración DNS actual.
Configurar el Parámetro de Solicitud DNS2Explicación
Configurar el Parámetro de Solicitud DNS2
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
main_record_type0 - main_record_type19El tipo de registro principal debe ser "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique el registro DNS para su dominio.
main_recordx0 - main_recordx19Distancia Mx, tipo de redireccionamiento (301 como "1", 302 como "2"), redirección del titular en modo oculto o alias de correo electrónico, necesario cuando main_record_type es "redireccionar", "mx", "modo oculto", "correo electrónico".
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99Tipo de registro de subdominio, debe ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99Dirección IP del subdominio o host de destino
sub_recordx0 - sub_recordx99Se requiere distancia mx, tipo de reenvío, título de redireccionamiento en modo oculto o alias de correo electrónico cuando main_record_type (tipo de registro principal) es "forward", "mx", "stealth", "email"
ttl (opcional)Tiempo de vida
add_dns_to_current_setting (opcional)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDnsResponse></SetDnsResponse>Nodo raíz del documento de respuesta XML
<SetDnsHeader></SetDnsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Configurar DNS2
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
<SetDnsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDnsHeader>
</SetDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1
Response (JSON format)
{
"SetDnsResponse": {
"ResponseCode": "0",
"Status": "success"
}
}
Orden de asignar reenvío de correo electrónico
Si estás llamando la orden de asignar reenvío de correo electrónico, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar reenvío de correo electrónicoExplicación
Parámetro de orden de asignar reenvío de correo electrónico
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
forward_typeTipo de reenvío, puede ser "donot": No reenviar el correo electrónico, "mx": Enviar correo electrónico a otro servidor de correo (registro MX), "forward": Remitir correo electrónico a otro servidor de correo
username0 - username9Nombre de usuario, sólo se utiliza cuando "forward_type" es "forward"
exist_email0 - exist_email9Dirección de correo electrónico existente, sólo se utiliza cuando "forward_type" es "forward"
mx_host0 - mx_host2Host de correo, sólo se utiliza cuando "forward_type" es "mx"
mx_distance0 - mx_distance2Distance0 es la prioridad más alta, sólo se utiliza cuando "forward_type" es "mx"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetEmailForwardingResponse></SetEmailForwardingResponse>Nodo raíz del documento de respuesta XML
<SetEmailForwardingHeader></SetEmailForwardingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de reenvío de correo electrónico
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]
Response (XML format)
<SetEmailForwardingResponse>
<SetEmailForwardingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]
Response (JSON format)
{
"SetEmailForwardingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Borrado de Configuración de Dominio
Si estás llamando la orden de eliminación de ajuste de dominio, hay que incluir los siguientes parámetros:
Parámetros de Establecer Solicitud Borrar Ajustes de DominioExplicación
Parámetros de Establecer Solicitud Borrar Ajustes de Dominio
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
serviceEl servicio que quieres eliminar puede ser "redireccionar", "modo oculto", "redireccionar correo electrónico", "dns" y " servidores de nombre "
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Nodo raíz del documento de respuesta XML
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de eliminación de ajuste de dominio
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Response (XML format)
<SetClearDomainSettingResponse>
<SetClearDomainSettingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_clear_domain_setting&domain=domain1.com&service=nameservers
Response (JSON format)
{
"SetClearDomainSettingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar carpeta
Si estás llamando la orden de asignar carpeta, hay que incluir los siguientes parámetros:
Establecer Parámetro de Solicitud de CarpetaExplicación
Establecer Parámetro de Solicitud de Carpeta
Explicación
domainEl dominio que deseas actualizar, sólo se puede cambiar 1 dominio a la vez por solicitud
folderEl nombre de la carpeta a la que desea mover su dominio. Utilice "Default" como nombre de la carpeta si desea mover el dominio a la carpeta predeterminada. El nombre de la carpeta distingue entre mayúsculas y minúsculas. Por ejemplo, "Folder1" y "folder1" son dos nombres de carpeta diferentes.
folder_id (opcional)El ID de la carpeta a la que desea trasladar su dominio
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderResponse></SetFolderResponse>Etiqueta de la respuesta establecer carpeta, es el nodo raíz del documento de respuesta XML
<SetFolderHeader></SetFolderHeader>Titulo de carpeta actual
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Configurar Carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder&domain=domian1.com&folder=folder1
Response (XML format)
<SetFolderResponse>
<SetFolderHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderHeader>
</SetFolderResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder&domain=domian1.com&folder=folder1
Response (JSON format)
{
"SetFolderResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar opción de renovación
Si estás llamando la orden de asignar opción de renovación, hay que incluir los siguientes parámetros:
Parámetros de orden de asignar opción de renovaciónExplicación
Parámetros de orden de asignar opción de renovación
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
renew_optionPuede ser "donot", "auto", "reset"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetRenewOptionResponse></SetRenewOptionResponse>Nodo raíz del documento de respuesta XML
<SetRenewOptionHeader></SetRenewOptionHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar opción de renovación
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto
Response (XML format)
<SetRenewOptionResponse>
<SetRenewOptionHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetRenewOptionHeader>
</SetRenewOptionResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto
Response (JSON format)
{
"SetRenewOptionResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar nota
Si estás llamando la orden de asignar nota, hay que incluir los siguientes parámetros:
Parámetros de Solicitud Establecer NotaExplicación
Parámetros de Solicitud Establecer Nota
Explicación
domainEl dominio que desea establecer, sólo se puede establecer 1 dominio por solicitud
noteNota que deseas agregar al dominio, puede ser nulo
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetNoteResponse></SetNoteResponse>Nodo raíz del documento de respuesta XML
<SetNoteHeader></SetNoteHeader>Encabezado de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar nota
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_note&domain=domain1.com¬e=Do not modify any information
Response (XML format)
<SetNoteResponse>
<SetNoteHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetNoteHeader>
</SetNoteResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_note&domain=domain1.com¬e=Do not modify any information
Response (JSON format)
{
"SetNoteResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Set Customer Id Command (RESELLER ONLY)
If calling set customer id command, the following parameters should be included:
Set Customer Id Request ParameterExplicación
Set Customer Id Request Parameter
Explicación
domainThe domain you want to set, multiple domains are separated by commas (Max:100)
customer_idCustomer id you want to set to the domain, can't be null
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetCustomerIdResponse></SetCustomerIdResponse>Nodo raíz del documento de respuesta XML
<SetCustomerIdHeader></SetCustomerIdHeader>Titulo de respuesta
<SetCustomerIdContent></SetCustomerIdContent>Contenido de respuesta
<SetCustomerIdSuccess></SetCustomerIdSuccess>Set customer id success response content
<SetCustomerIdFailed></SetCustomerIdFailed>Set customer id failed response content
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure, "1" for problem
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Set Customer Id Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456
Response (XML format)
<SetCustomerIdResponse>
<SetCustomerIdHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</SetCustomerIdHeader>
<SetCustomerIdContent>
<SetCustomerIdSuccess>
<content>
<Domain>domain1.com</Domain>
<CustomerId>123456</CustomerId>
</content>
<content>
<Domain>domain2.com</Domain>
<CustomerId>123456</CustomerId>
</content>
</SetCustomerIdSuccess>
</SetCustomerIdContent>
</SetCustomerIdResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456
Response (JSON format)
{
"SetCustomerIdResponse": {
"ResponseCode": 0,
"Status": "success",
"SetCustomerIdSuccess": [
{
"Domain": "domain1.com",
"CustomerId": 123456
},
{
"Domain": "domain2.com",
"CustomerId": 123456
}
]
}
}
Orden de asignar privacidad
Si llamando la orden de asignar la privacidad, hay que incluir los siguientes parámetros:
Parámetro de asignar privacidadExplicación
Parámetro de asignar privacidad
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
optionEl estado de privacidad del dominio que desea configurar, puede ser "full", "partial", o "off"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetPrivacyResponse></SetPrivacyResponse>Nodo raíz del documento de respuesta XML
<SetPrivacyHeader></SetPrivacyHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar privacidad
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_privacy&domain=domain1.com&option=off
Response (XML format)
<SetPrivacyResponse>
<SetPrivacyHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetPrivacyHeader>
</SetPrivacyResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_privacy&domain=domain1.com&option=off
Response (JSON format)
{
"SetPrivacyResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Precios de TLD
This feature is only available in XML and JSON format:
Parámetro de Solicitud de Precios de los TLDExplicación
Parámetro de Solicitud de Precios de los TLD
Explicación
currency (opcional)La moneda resultante de la devolución, debe ser la moneda predeterminada "usd", "eur", o "cny", que es la Moneda por Defecto de la Api de la configuración de cuenta
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<TldPriceResponse></TldPriceResponse>Nodo raíz del documento de respuesta XML
<TldPriceResponseHeader></TldPriceResponseHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<TldPriceContent></TldPriceContent>Contenido de respuesta
<TldContent></TldContent>Información sobre el Tld
<Tld></Tld>Dominios de Nivel Superior
<Usage></Usage>Uso del tld
<Price></Price>Price info of this tld. Contain sub-tags:
: Unit of price
: Price of Registration
: Price of Renew
: Price of Transfer
<Privacy></Privacy>Si, este tld admite la privacidad whois
<GracePeriod></GracePeriod>Grace period info of this tld. Contain sub-tags:
: Unit of grace period info
: Renew grace period
: Delete grace period
<IDN></IDN>Si, este tld admite Nombres de Dominio internacionalizados
<Restrictions></Restrictions>nombre de dominio
Ejemplo de precios de los TLD
Request (XML format)
https://api.dynadot.com/api3.xml?key=0&command=tld_price¤cy=USD
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
<TldPriceResponseHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
<PriceLevel>Regular Pricing</PriceLevel>
<Currency>USD</Currency>
</TldPriceResponseHeader>
<TldPriceContent>
<TldContent>
<Tld>.com</Tld>
<Usage>Usage</Usage>
<Price>
<Unit>(Price/1 year)</Unit>
<Register>99.00</Register>
<Renew>60.00</Renew>
<Transfer>92.00</Transfer>
</Price>
<Privacy>Yes</Privacy>
<GracePeriod>
<Unit>(Grace Period/days)</Unit>
<Renew>40</Renew>
<Delete>5</Delete>
</GracePeriod>
<IDN>Yes</IDN>
<Restrictions>--</Restrictions>
</TldContent>
</TldPriceContent>
</TldPriceResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=0&command=tld_price¤cy=USD
Response (JSON format)
{
"TldPriceResponse": {
"ResponseCode": 0,
"Status": "success",
"PriceLevel": "Regular Pricing",
"Currency": "USD",
"TldPrice": [
{
"Tld": ".com",
"Usage": "Usage",
"Price": {
"Unit": "(Price/1 year)",
"Register": "99.00",
"Renew": "60.00",
"Transfer": "92.00"
},
"Privacy": "Yes",
"GracePeriod": {
"Unit": "(Grace Period/days)",
"Renew": "40",
"Delete": "5"
},
"IDN": "Yes",
"Restrictions": "--"
}
]
}
}
Orden de lista de dominio
This feature is only available in XML and JSON format:
Parámetro de orden de lista de dominioExplicación
Parámetro de orden de lista de dominio
Explicación
customer_id (opcional)Filter data by customer id (only resellers can use this parameter)
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<ListDomainInfoResponse></ListDomainInfoResponse>Nodo raíz del documento de respuesta XML
<ListDomainInfoHeader></ListDomainInfoHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<ListDomainInfoContent></ListDomainInfoContent>Contenido de respuesta
<DomainInfoList></DomainInfoList>Lista de información del dominio
<DomainInfo></DomainInfo>Información de dominio
<Domain></Domain>Dominio
<Name></Name>nombre de dominio
<Expiration></Expiration>Fecha de caducidad de dominio en tiempo Unix (milisegundos desde la medianoche UTC de enero 1, 1970)
<Registration></Registration>Fecha de registro del dominio en tiempo Unix (milisegundos desde la medianoche UTC de 1, 1970 de enero)
<NameServerSettings></NameServerSettings>Configuración del servidor de nombres
<Type></Type>Tipo de configuración de servidor de nombres
<WithAds></WithAds>Con publicidades o sin publicidades
<Whois></Whois>Información Whois
<Registrant></Registrant>Información del registrante
<ContactId></ContactId>Idenentificación de contacto
<Admin></Admin>Información de administración
<Technical></Technical>Información técnica
<Billing></Billing>Información de facturación
<Locked></Locked>Bloqueado o no
<Disabled></Disabled>Estatus de permisión
<Hold></Hold>En espera
<Privacy></Privacy>Estatus de privacidad
<isForSale></isForSale>Estatus de liquidación
<RenewOption></RenewOption>Opción de renovación
<Note></Note>Notas
<Folder></Folder>Información de carpeta
<FolderId></FolderId>ID de Carpeta
<FolderName></FolderName>Nombre de carpeta
Ejemplo de Listado de Dominio
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=list_domain
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
<ListDomainInfoHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</ListDomainInfoHeader>
<ListDomainInfoContent>
<DomainInfoList>
<DomainInfo>
<Domain>
<Name>domain-exp140.com</Name>
<Expiration>1361430589062</Expiration>
<Registration>1234567890123</Registration>
<NameServerSettings>
<Type>Dynadot Parking</Type>
<WithAds>Yes</WithAds>
</NameServerSettings>
<Whois>
<Registrant>
<ContactId>0</ContactId>
</Registrant>
<Admin>
<ContactId>0</ContactId>
</Admin>
<Technical>
<ContactId>0</ContactId>
</Technical>
<Billing>
<ContactId>0</ContactId>
</Billing>
</Whois>
<Locked>yes</Locked>
<Disabled>no</Disabled>
<UdrpLocked>no</UdrpLocked>
<RegistrantUnverified>no</RegistrantUnverified>
<Hold>no</Hold>
<Privacy>none</Privacy>
<isForSale>no</isForSale>
<RenewOption>no renew option</RenewOption>
<Note/>
<Folder>
<FolderId>-1</FolderId>
<FolderName>(no folder)</FolderName>
</Folder>
</Domain>
<Domain>
<Name>domain-exp141.com</Name>
<Expiration>1361430589062</Expiration>
<Registration>1234567890123</Registration>
<NameServerSettings>
<Type>Dynadot Parking</Type>
<WithAds>Yes</WithAds>
</NameServerSettings>
<Whois>
<Registrant>
<ContactId>1</ContactId>
</Registrant>
<Admin>
<ContactId>2</ContactId>
</Admin>
<Technical>
<ContactId>3</ContactId>
</Technical>
<Billing>
<ContactId>4</ContactId>
</Billing>
</Whois>
<Locked>yes</Locked>
<Disabled>no</Disabled>
<UdrpLocked>no</UdrpLocked>
<RegistrantUnverified>no</RegistrantUnverified>
<Hold>no</Hold>
<Privacy>none</Privacy>
<isForSale>no</isForSale>
<RenewOption>no renew option</RenewOption>
<Note/>
<Folder>
<FolderId>-1</FolderId>
<FolderName>(no folder)</FolderName>
</Folder>
</Domain>
</DomainInfo>
</DomainInfoList>
</ListDomainInfoContent>
</ListDomainInfoResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=list_domain
Response (JSON format)
{
"ListDomainInfoResponse": {
"ResponseCode": 0,
"Status": "success",
"MainDomains": [
{
"Name": "domain-exp140.com",
"Expiration": "1361430589062",
"Registration": "1234567890123",
"NameServerSettings": {
"Type": "Dynadot Parking",
"WithAds": "Yes"
},
"Whois": {
"Registrant": {
"ContactId": "0"
},
"Admin": {
"ContactId": "0"
},
"Technical": {
"ContactId": "0"
},
"Billing": {
"ContactId": "0"
}
},
"Locked": "yes",
"Disabled": "no",
"UdrpLocked": "no",
"RegistrantUnverified": "no",
"Hold": "no",
"Privacy": "none",
"isForSale": "no",
"RenewOption": "no renew option",
"Note": "",
"Folder": {
"FolderId": "-1",
"FolderName": "(no folder)"
}
},
{
"Name": "domain-exp141.com",
"Expiration": "1361430589062",
"Registration": "1234567890123",
"NameServerSettings": {
"Type": "Dynadot Parking",
"WithAds": "Yes"
},
"Whois": {
"Registrant": {
"ContactId": "1"
},
"Admin": {
"ContactId": "2"
},
"Technical": {
"ContactId": "3"
},
"Billing": {
"ContactId": "4"
}
},
"Locked": "yes",
"Disabled": "no",
"UdrpLocked": "no",
"RegistrantUnverified": "no",
"Hold": "no",
"Privacy": "none",
"isForSale": "no",
"RenewOption": "no renew option",
"Note": "",
"Folder": {
"FolderId": "-1",
"FolderName": "(no folder)"
}
}
]
}
}
Orden de crear contacto
Si estás llamando la orden de crear contacto, hay que incluir los siguientes parámetros:
Parámetro Solicitud Crear ContactoExplicación
Parámetro Solicitud Crear Contacto
Explicación
organization (opcional)La información de la organización
nameNombre
emailCorreo electrónico
phonenumNúmero de teléfono
phoneccCódigo de país del número de teléfono
faxnum (opcional)Número fax
faxcc (opcional)Código de país del número fax
address1Linea 1 de la dirección
address2 (opcional)Dirección 2
cityCiudad
state (opcional)Estado
zipCódigo Postal
countryPaís
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<CreateContactResponse></CreateContactResponse>Nodo raíz del documento de respuesta XML
<CreateContactHeader></CreateContactHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<CreateContactContent></CreateContactContent>New Contact ID, only used when status is "success"
Ejemplo de orden de crear contacto
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Response (XML format)
<CreateContactResponse>
<CreateContactHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</CreateContactHeader>
<CreateContactContent>
<ContactId>1234</ContactId>
</CreateContactContent>
</CreateContactResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=create_contact&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US
Response (JSON format)
{
"CreateContactResponse":{
"ResponseCode":"0",
"Status":"success",
"CreateContactContent":{
"ContactId":"0"
}
}
}
Orden de editar contacto
Si estás llamando la orden de editar contacto, hay que incluir los parámetros siguientes:
Parámetro Solicitud Editar ContactoExplicación
Parámetro Solicitud Editar Contacto
Explicación
contact_idID del contacto que desea editar
organization (opcional)La información de la organización
nameNombre
emailCorreo electrónico
phonenumNúmero de teléfono
phoneccCódigo de país del número de teléfono
faxnum (opcional)Número fax
faxcc (opcional)Código de país del número fax
address1Dirección 1
address2 (opcional)Dirección 2
cityCiudad
stateEstado
zipCódigo Postal
countryPaís
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<EditContactResponse></EditContactResponse>Nodo raíz del documento de respuesta XML
<EditContactHeader></EditContactHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<EditContactContent></EditContactContent>Contenido de respuesta
<ContactId></ContactId>ID del contacto
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
<EditContactHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</EditContactHeader>
<EditContactContent>
<ContactId>0</ContactId>
</EditContactContent>
</EditContactResponse>
Request (CSV format)
https://api.dynadot.com/api3.html?key=mykey&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Response (CSV format)
ok,
success,
,
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=edit_contact&contact_id=0&name=Webb&[email protected]&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US
Response (JSON format)
{
"EditContactResponse": {
"ResponseCode": "0",
"Status": "success",
"EditContactContent": {
"ContactId": "0"
}
}
}
Set Contact EU Setting Command
If calling set contact eu setting command, the following parameters should be included:
Set Contact EU Setting Request ParameterExplicación
Set Contact EU Setting Request Parameter
Explicación
contact_idID del contacto que desea editar
country_of_citizenshipMust be an EU member state, The country codes of member states include :
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
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetContactEUSettingResponse></SetContactEUSettingResponse>Nodo raíz del documento de respuesta XML
<SetContactEUSettingHeader></SetContactEUSettingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<SetContactEUSettingContent></SetContactEUSettingContent>Contenido de respuesta
<ContactId></ContactId>ID del contacto
Set Contact EU Setting Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
<SetContactEUSettingHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</SetContactEUSettingHeader>
<SetContactEUSettingContent>
<ContactId>0</ContactId>
</SetContactEUSettingContent>
</SetContactEUSettingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT
Response (JSON format)
{
"SetContactEUSettingResponse": {
"ResponseCode: ": "0",
"Status": "Success",
"SetContactEUSettingContent": {
"ContactId: ": "0"
}
}
}
Set Contact LV Setting Command
If calling set contact lv setting command, the following parameters should be included:
Set Contact LV Setting Request ParameterExplicación
Set Contact LV Setting Request Parameter
Explicación
contact_idID del contacto que desea editar
registration_number- For individual, Please enter Latvian identification number.
- For companies and other legal entities, please enter registration number issued by the Latvian Register of Enterprises.
vat_number (opcional)VAT number for foreign legal entities registered within European Union countries (this includes also Latvian companies)
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetContactLvSettingResponse></SetContactLvSettingResponse>Nodo raíz del documento de respuesta XML
<SetContactLvSettingHeader></SetContactLvSettingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<SetContactLvSettingContent></SetContactLvSettingContent>Contenido de respuesta
<ContactId></ContactId>ID del contacto
Set Contact LV Setting Example
Request (CSV format)
https://api.dynadot.com/api3.csv?key=mykey&command=set_contact_lv_setting&contact_id=0®istration_number=test_reg_number&vat_number=test_vat_number
Response (CSV format)
ok,success,0
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_contact_lv_setting&contact_id=0®istration_number=test_reg_number&vat_number=test_vat_number
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
<SetContactLvSettingHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</SetContactLvSettingHeader>
<SetContactLvSettingContent>
<ContactId>0</ContactId>
</SetContactLvSettingContent>
</SetContactLvSettingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_contact_lv_setting&contact_id=0®istration_number=test_reg_number&vat_number=test_vat_number
Response (JSON format)
{
"SetContactLvSettingResponse": {
"ResponseCode": 0,
"Status": "success",
"SetContactLvSettingContent": {
"ContactId: ": "0"
}
}
}
Orden de eliminar contacto
Si estás llamando la orden de eliminar contacto, hay que incluir los siguientes parámetros:
Parámetro de orden de eliminar contactoExplicación
Parámetro de orden de eliminar contacto
Explicación
contact_idID del contacto que desea eliminar, asegúrese de que estén separados por comas
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DeleteContactResponse></DeleteContactResponse>Nodo raíz del documento de respuesta XML
<DeleteContactHeader></DeleteContactHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de eliminar contacto
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=delete_contact&contact_id=0
Response (XML format)
<DeleteContactResponse>
<DeleteContactHeader>
<SuccessCode>-1</SuccessCode>
<Status>error</Status>
<Error>cannot delete these contacts (Jack Slater). Because they are in use.</Error>
</DeleteContactHeader>
</DeleteContactResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=delete_contact&contact_id=0
Response (JSON format)
{
"DeleteContactResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de lista de contactos
This command is only available in XML and JSON format:
Parámetro de orden de lista de contactosExplicación
Parámetro de orden de lista de contactos
Explicación
N/ANo se requiere ningún parámetro adicional
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<ContactListResponse></ContactListResponse>Nodo raíz del documento de respuesta XML
<ContactListHeader></ContactListHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<ContactListContent></ContactListContent>Contenido de respuesta
<ContactList></ContactList>Lista de contactos
<Contact></Contact>Información de contacto
<ContactId></ContactId>ID del Contacto
<Organization></Organization>Organización del contacto
<Name></Name>Nombre
<Email></Email>Correo electrónico
<PhoneCc></PhoneCc>Código de país del número de teléfono
<PhoneNum></PhoneNum>Número de teléfono
<FaxCc></FaxCc>Código de país del número fax
<FaxNum></FaxNum>Número fax
<Address1></Address1>Dirección 1
<Address2></Address2>Dirección 2
<City></City>Ciudad
<State></State>Estado
<ZipCode></ZipCode>Código Postal
<Country></Country>País
<GtldVerified></GtldVerified>Estado de verificación de gTLD
Ejemplo de orden de lista de contactos
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=contact_list
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
<ContactListHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</ContactListHeader>
<ContactListContent>
<ContactList>
<Contact>
<ContactId>0</ContactId>
<Organization/>
<Name>Jack Slater</Name>
<Email>[email protected]</Email>
<PhoneCc>1</PhoneCc>
<PhoneNum>555.555.5233</PhoneNum>
<FaxCc/>
<FaxNum/>
<Address1>1 Free Way</Address1>
<Address2/>
<City>Los Angeles</City>
<State>CA</State>
<ZipCode>90068</ZipCode>
<Country>US</Country>
<GtldVerified>no</GtldVerified>
</Contact>
<Contact>
<ContactId>1</ContactId>
<Organization/>
<Name>John tester</Name>
<Email>[email protected]</Email>
<PhoneCc>1</PhoneCc>
<PhoneNum>123.456.7890</PhoneNum>
<FaxCc>1</FaxCc>
<FaxNum>123.456.7890</FaxNum>
<Address1>high Way first</Address1>
<Address2/>
<City>San Francisco</City>
<State>CA</State>
<ZipCode>90068</ZipCode>
<Country>US</Country>
<GtldVerified>yes</GtldVerified>
</Contact>
</ContactList>
</ContactListContent>
</ContactListResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=contact_list
Response (JSON format)
{
"ContactListResponse": {
"ResponseCode": 0,
"Status": "success",
"ContactList": [
{
"ContactId": "0",
"Organization": "",
"Name": "Jack Slater",
"Email": "[email protected]",
"PhoneCc": "1",
"PhoneNum": "555.555.5233",
"FaxCc": "",
"FaxNum": "",
"Address1": "1 Free Way",
"Address2": "",
"City": "Los Angeles",
"State": "CA",
"ZipCode": "90068",
"Country": "US",
"GtldVerified": "no"
},
{
"ContactId": "1",
"Organization": "",
"Name": "John tester",
"Email": "[email protected]",
"PhoneCc": "1",
"PhoneNum": "123.456.7890",
"FaxCc": "1",
"FaxNum": "123.456.7890",
"Address1": "high Way first",
"Address2": "",
"City": "San Francisco",
"State": "CA",
"ZipCode": "90068",
"Country": "US",
"GtldVerified": "yes"
}
]
}
}
Comando Obtener Contacto
This command is only available in XML and JSON format:
Parámetros de Solicitud Obtener ContactoExplicación
Parámetros de Solicitud Obtener Contacto
Explicación
contact_idID de contacto
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetContactResponse></GetContactResponse>Nodo raíz del documento de respuesta XML
<GetContactHeader></GetContactHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetContactContent></GetContactContent>Contenido de respuesta
<Contact></Contact>Información de contacto
<ContactId></ContactId>ID del Contacto
<Organization></Organization>Organización del contacto
<Name></Name>Nombre
<Email></Email>Correo electrónico
<PhoneCc></PhoneCc>Código de país del número de teléfono
<PhoneNum></PhoneNum>Número de teléfono
<FaxCc></FaxCc>Código de país del número fax
<FaxNum></FaxNum>Número fax
<Address1></Address1>Dirección 1
<Address2></Address2>Dirección 2
<City></City>Ciudad
<State></State>Estado
<ZipCode></ZipCode>Código Postal
<Country></Country>País
<GtldVerified></GtldVerified>Estado de verificación de gTLD
Ejemplo Obtener Contacto
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_contact&contact_id=10000
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
<GetContactHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</GetContactHeader>
<GetContactContent>
<GetContact>
<Contact>
<ContactId>12345</ContactId>
<Organization>org</Organization>
<Name>name</Name>
<Email>[email protected]</Email>
<PhoneCc>1</PhoneCc>
<PhoneNum>555.555.5233</PhoneNum>
<FaxCc/>
<FaxNum/>
<Address1>address1</Address1>
<Address2>address2</Address2>
<City>city</City>
<State>state</State>
<ZipCode>zipcode</ZipCode>
<Country>country</Country>
<GtldVerified>no</GtldVerified>
</Contact>
</GetContact>
</GetContactContent>
</GetContactResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_contact&contact_id=10000
Response (JSON format)
{
"GetContactResponse": {
"ResponseCode": 0,
"Status": "success",
"GetContact": {
"ContactId": "12345",
"Organization": "org",
"Name": "name",
"Email": "[email protected]",
"PhoneCc": "1",
"PhoneNum": "555.555.5233",
"FaxCc": "",
"FaxNum": "",
"Address1": "address1",
"Address2": "address2",
"City": "city",
"State": "state",
"ZipCode": "zipcode",
"Country": "country",
"GtldVerified": "no"
}
}
}
Obtener comando de servidor de nombres
Si invoca el comando 'get name server', se deben incluir los siguientes parámetros:
Parámetro de solicitud del servidor de nombresExplicación
Parámetro de solicitud del servidor de nombres
Explicación
domainEl dominio de la que deseas obtener información de servidor de nombre, sólo se puede obtener la información de servidor de nombre para 1 dominio a la vez por solicitud.
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetNsResponse></GetNsResponse>Nodo raíz del documento de respuesta XML
<GetNsHeader></GetNsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<NsContent></NsContent>Contenido de respuesta
<Host></Host>Nombre de host del servidor
<NsName></NsName>Nombre del servidor
Obtener ejemplo de servidor de nombres
Request (XML format)
https://api.dynadot.com/api3.html?key=mykey&command=get_ns&domain=mydomain.com
Response (XML format)
<GetNsResponse>
<GetNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetNsHeader>
<NsContent>
<Host>ns1.mydomain.com</Host>
<Host>ns2.mydomain.com</Host>
</NsContent>
</GetNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_ns&domain=mydomain.com
Response (JSON format)
{
"GetNsResponse":{
"ResponseCode":"0",
"Status":"success",
"NsContent":{
"Host":"ns1.mydomain.com",
"Host":"ns2.mydomain.com"
}
}
}
Comando Añadir Servidor de Nombres
Si invoca el comando añadir servidor de nombres, se deben incluir los siguientes parámetros:
Parámetros Solicitud Añadir Servidor de NombresExplicación
Parámetros Solicitud Añadir Servidor de Nombres
Explicación
hostEl nombre de host del servidor de nombres que desea agregar
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<AddNsResponse></AddNsResponse>Nodo raíz del documento de respuesta XML
<AddNsHeader></AddNsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<AddNsContent></AddNsContent>Contenido de respuesta
<Server></Server>Servidor que tienes activado
<Host></Host>Nombre host del servidor nuevo
<ServerId></ServerId>El ID del nuevo servidor
Ejemplo Añadir Servidor de Nombres
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=add_ns&host=ns1.mydomain.com
Response (XML format)
<AddNsResponse>
<AddNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</AddNsHeader>
<AddNsContent>
<Server>
<Host>ns1.mydomain.com</Host>
<ServerId>0</ServerId>
</Server>
</AddNsContent>
</AddNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=add_ns&host=ns1.mydomain.com
Response (JSON format)
{
"AddNsResponse":{
"ResponseCode":"0",
"Status":"success",
"AddNsContent":{
"Server":{
"Host":"ns1.mydomain.com",
"ServerId":"0"
}
}
}
}
Comando Registro de Servidor de Nombres
Si invoca el comando registro de servidor de nombres, se deben incluir los siguientes parámetros:
Parámetro Solicitud Registro de Servidor de NombresExplicación
Parámetro Solicitud Registro de Servidor de Nombres
Explicación
hostEl nombre del host de su propio servidor de nombres
ipLa dirección IP de su propio servidor de nombres
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<RegisterNsResponse></RegisterNsResponse>Nodo raíz del documento de respuesta XML
<RegisterNsHeader></RegisterNsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<RegisterNsContent></RegisterNsContent>Contenido de respuesta
<Server></Server>Etiqueta del servidor
<Host></Host>Nombre del host
<ServerId></ServerId>ID del servidor
Ejemplo Registro Servidor de Nombres
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=register_ns&host=domain1.com&ip=192.168.1.1
Response (XML format)
<RegisterNsResponse>
<RegisterNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</RegisterNsHeader>
<RegisterNsContent>
<Server>
<Host>domain1.com</Host>
<ServerId>0</ServerId>
</Server>
</RegisterNsContent>
</RegisterNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=register_ns&host=domain1.com&ip=192.168.1.1
Response (JSON format)
{
"RegisterNsResponse":{
"ResponseCode":"0",
"Status":"success",
"RegisterNsContent":{
"Server":{
"Host":"ndomain1.com",
"ServerId":"0"
}
}
}
}
Comando Establecer IP de Servidor de Nombres
Si invoca el comando establecer IP de servidor de nombres, se deben incluir los siguientes parámetros:
Parámetros Solicitud Establecer IP de Servidor de NombresExplicación
Parámetros Solicitud Establecer IP de Servidor de Nombres
Explicación
server_idID del servidor de nombres que desea establecer
ip0 - ip9La dirección IP que desea configurar para el servidor de nombres, se puede configurar 9 direcciones IP por solicitud y deben estar separadas por comas
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetNsIpResponse></SetNsIpResponse>Nodo raíz del documento de respuesta XML
<SetNsIpHeader></SetNsIpHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Establecer IP de Servidor de Nombres
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Response (XML format)
<SetNsIpResponse>
<SetNsIpHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetNsIpHeader>
</SetNsIpResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_ns_ip&server_id=1&ip0=192.168.1.1
Response (JSON format)
{
"SetNsIpResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Eliminar Servidor de Nombres
Si invoca el comando eliminar servidor de nombres, se deben incluir los siguientes parámetros:
Parámetros Solicitud Eliminar Servidor de NombresExplicación
Parámetros Solicitud Eliminar Servidor de Nombres
Explicación
server_idID de los servidores de nombres que desea eliminar, asegúrese de que estén separados por comas
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DeleteNsResponse></DeleteNsResponse>Nodo raíz del documento de respuesta XML
<DeleteNsHeader></DeleteNsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Eliminar Servidor de Nombres
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns&server_id=0
Response (XML format)
<DeleteNsResponse>
<DeleteNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=delete_ns&server_id=0
Response (JSON format)
{
"DeleteNsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Eliminar servidor de nombres por comando de dominio
If calling delete name server by domain command, the following parameters should be included:
Eliminar servidor de nombres por parámetro de solicitud de dominioExplicación
Eliminar servidor de nombres por parámetro de solicitud de dominio
Explicación
server_domainNombre del servidor de nombres. ej: ns1.testnameserver.com
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DeleteNsResponse></DeleteNsResponse>Nodo raíz del documento de respuesta XML
<DeleteNsHeader></DeleteNsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Delete Name Server By Domain Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Response (XML format)
<DeleteNsResponse>
<DeleteNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com
Response (JSON format)
{
"DeleteNsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de lista de servidores
This command is only available in XML and JSON format:
Parámetro de orden de lista de servidoresExplicación
Parámetro de orden de lista de servidores
Explicación
N/ANo se requiere ningún parámetro adicional
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<ServerListResponse></ServerListResponse>Nodo raíz del documento de respuesta XML
<ServerListHeader></ServerListHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<ServerListContent></ServerListContent>Contenido de respuesta
<NameServerList></NameServerList>Lista de servidor de nombres
<List></List>
<Server></Server>
<ServerId></ServerId>ID del servidor
<ServerName></ServerName>Nombre del servidor
<ServerIp></ServerIp>IP del servidor
Ejemplo de orden de lista de servidores
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=server_list
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
<ServerListHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</ServerListHeader>
<ServerListContent>
<NameServerList>
<List>
<Server>
<ServerId>0</ServerId>
<ServerName>ns1.com</ServerName>
</Server>
<Server>
<ServerId>1</ServerId>
<ServerName>domain1.com</ServerName>
<ServerIp>192.168.1.1</ServerIp>
</Server>
</List>
</NameServerList>
</ServerListContent>
</ServerListResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=server_list
Response (JSON format)
{
"ServerListResponse": {
"ResponseCode": 0,
"Status": "success",
"ServerList": [
{
"ServerId": "0",
"ServerName": "ns1.com"
},
{
"ServerId": "1",
"ServerName": "domain1.com",
"ServerIp": "192.168.1.1"
}
]
}
}
Get Domain NameServer Settings Command
If calling get domain nameservers settings command, the following parameters should be included:
Get Domain Nameserver Settings Request ParameterExplicación
Get Domain Nameserver Settings Request Parameter
Explicación
domainThe domain whose name server setting you want to get, only 1 domain's name server setting can be pulled per request.
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetDnsResponse></GetDnsResponse>Nodo raíz del documento de respuesta XML
<GetDnsHeader></GetDnsHeader>Titulo de respuesta
<ResponseCode></ResponseCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetDnsContent></GetDnsContent>Contenido de respuesta
<NameServerSettings></NameServerSettings>Configuración de servidor de nombres de dominio
<Type></Type>Tipo de servidor de nombres de dominio
Get Domain Nameserver Settings Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_dns&domain=mydomain.com
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
<GetDnsHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</GetDnsHeader>
<GetDnsContent>
<NameServerSettings>
<Type>Dynadot Parking</Type>
<WithAds>Yes</WithAds>
</NameServerSettings>
</GetDnsContent>
</GetDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_dns&domain=mydomain.com
Response (JSON format)
{
"GetDnsResponse": {
"ResponseCode": 0,
"Status": "success",
"GetDns": {
"NameServerSettings": {
"Type": "Dynadot Parking",
"WithAds": "Yes"
}
}
}
}
Obtener comando de código de autenticación de transferencia
Debe desbloquear su dominio y su cuenta antes de solicitar el código de autorización.
Obtener parámetro de solicitud de código de autorización de transferenciaExplicación
Obtener parámetro de solicitud de código de autorización de transferencia
Explicación
domainEl nombre de dominio para el que desea obtener el código de autorización de transferencia, sólo puede ingresarse el dominio 1 por solicitud
new_code (optional)Generar un nuevo código de autorización de transferencia
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)Si quiere desbloquear el dominio para transferencia, configúrelo como "1". Si la solicitud se procesa con éxito, el dominio se desbloqueará.
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<AuthCode></AuthCode>El código de autorización se utiliza para iniciar una transferencia de dominio.
Ejemplo de Código de Autorización de Transferencia
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Response (XML format)
<GetTransferAuthCodeResponse>
<GetTransferAuthCodeHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
<AuthCode>testauthcode</AuthCode>
</GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1
Response (JSON format)
{
"GetTransferAuthCodeResponse":{
"ResponseCode":"0",
"Status":"success",
"AuthCode":"testauthcode"
}
}
Get Transfer Status Command
If calling get transfer status command, the following parameters should be included:
Get Transfer Status Request ParameterExplicación
Get Transfer Status Request Parameter
Explicación
domainThe domain name you want to get transfer status for, only 1 domain can be entered per request
transfer_typeThe transfer type you want to get transfer status for (transfer in or transfer away)
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetTransferStatusResponse></GetTransferStatusResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetTransferStatusHeader></GetTransferStatusHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetTransferStatusContent></GetTransferStatusContent>Contenido de respuesta
<TransferList></TransferList>Transfer list
<Transfer></Transfer>Transfer info
<OrderId></OrderId>The order id
<TransferStatus></TransferStatus>The transfer status of domain.If you got 'none' or 'approved', you can cancel the transfer.If you got 'waiting', means transfer already start.If you got 'auth code needed', means bad auth code, you can use another api SET_TRANSFER_AUTH re-submit auth code.There are also some other statuses, we will send you an email or needs to be checked by our engineers.
Get Transfer Status Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_status&domain=domian1.com&transfer_type=in
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
<GetTransferStatusHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetTransferStatusHeader>
<GetTransferStatusContent>
<TransferList>
<Transfer>
<OrderId>testorderid</OrderId>
<TransferStatus>teststatus</TransferStatus>
</Transfer>
<Transfer>
<OrderId>testorderid2</OrderId>
<TransferStatus>teststatus2</TransferStatus>
</Transfer>
</TransferList>
</GetTransferStatusContent>
</GetTransferStatusResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_transfer_status&domain=domian1.com&transfer_type=in
Response (JSON format)
{
"GetTransferStatusResponse": {
"ResponseCode": 0,
"Status": "success",
"TransferList": [
{
"OrderId": "testorderid",
"TransferStatus": "teststatus"
},
{
"OrderId": "testorderid2",
"TransferStatus": "teststatus2"
}
]
}
}
Set Transfer Auth Code For Transfer Order Command
The command which allows you to update auth code for processing transfer orders. If calling set transfer auth code command, the following parameters should be included:
Set Transfer Auth Code Request ParameterExplicación
Set Transfer Auth Code Request Parameter
Explicación
domainThe domain name you update the transfer auth for, only 1 domain can be entered per request
auth_codeThe auth_code you want to re-submit
order_idThe transfer order id, you can get it from another api get_transfer_status.
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetTransferStatusResponse></GetTransferStatusResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetTransferStatusHeader></GetTransferStatusHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Set Transfer Auth Code Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Response (XML format)
<SetTransferAuthCodeResponse>
<SetTransferAuthCodeHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode
Response (JSON format)
{
"SetTransferAuthCodeResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Cancel Transfer For Order Command
The Command allows you to cancel a transfer item in the order. If calling cancel transfer command, the following parameters should be included:
Cancel Transfer Request ParameterExplicación
Cancel Transfer Request Parameter
Explicación
domainThe domain name you want to cancel transfer for, only 1 domain can be entered per request
order_idThe transfer order id, you can get it from another api get_transfer_status.
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<CancelTransferResponse></CancelTransferResponse>Nodo raiz de la respuesta del documento XMLXML documento
<CancelTransferHeader></CancelTransferHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Cancel Transfer Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=cancel_transfer&domain=domain4.com
Response (XML format)
<CancelTransferResponse>
<CancelTransferHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</CancelTransferHeader>
</CancelTransferResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=cancel_transfer&domain=domain4.com
Response (JSON format)
{
"CancelTransferResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Authorize Transfer Away Command (RESELLER ONLY)
Authorize Transfer Away Request ParameterExplicación
Authorize Transfer Away Request Parameter
Explicación
domainThe domain name you want to authorize transfer away for, only 1 domain can be entered per request
order_idThe Dynadot order_id of the domain you want to transfer away
authorizeTo authorize the transfer away, set it equal to "approve". To deny the transfer away, set it equal to "deny".
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>Nodo raiz de la respuesta del documento XMLXML documento
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<Result></Result>The result of authorize transfer away
Authorize Transfer Away Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123
Response (XML format)
<AuthorizeTransferAwayResponse>
<AuthorizeTransferAwayHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
<Result>away_approved</Result>
</AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123
Response (JSON format)
{
"AuthorizeTransferAwayResponse":{
"ResponseCode":"0",
"Status":"success",
"Result":"away_approved"
}
}
Create CN Audit Command
The Command allows you to create a CN audit for a contact. If calling create cn audit command, the following parameters should be included:
Create CN Audit Request ParameterExplicación
Create CN Audit Request Parameter
Explicación
contact_idThe contact record id you want start audit for, only 1 contact id can be entered per request
contact_typeType of contact, can be either "Individual" or "Enterprise"
individual_id_typeNatural person's ID type, expected values (description of value) are:
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)
individual_license_idThe License number of natural person's ID
individual_urlDocument of natural person license ID. The file url on the server. Only jpg, gif, png, jpeg are allowed
enterprise_id_type (Mandatory when contact type is "Enterprise")Enterprise ID type, expected values (description of value) are:
ORG (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)
enterprise_license_id (Mandatory when contact type is "Enterprise")The License number of enterprise document
enterprise_url (Mandatory when contact type is "Enterprise")Document of enterprise license. The file url on the server. Only jpg, gif, png, jpeg are allowed
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<CreateCnAuditResponse></CreateCnAuditResponse>Nodo raíz del documento de respuesta XML
<CreateCnAuditHeader></CreateCnAuditHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Create CN Audit Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2
Response (XML format)
<CreateCnAuditResponse>
<CreateCnAuditHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</CreateCnAuditHeader>
</CreateCnAuditResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=create_cn_audit&contact_id=testcontactid&license_id=testlicenseid&url=url
Response (JSON format)
{
"CreateCnAuditResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Get Cn Audit Status Command
If calling get cn audit status command, the following parameters should be included:
Get Cn Audit Status Request ParameterExplicación
Get Cn Audit Status Request Parameter
Explicación
contact_idThe contact record id you want to get audit status for, only 1 contactId can be entered per request
gtldIf you query the audit result of the cnnic-gtld, set this parameter to 1
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<CnAuditStatus></CnAuditStatus>the audit status of cnnic audit record. You may got 'processing' or 'waiting for cnnic' or 'failed'. If failed, we will send you an email.
<FailedReason></FailedReason>If the audit unpass, the failed reason will be displayed
Get Cn Audit Status Example
Request (XML format)
https://api.dynadot.xml/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
<GetCnAuditStatusHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
<CnAuditStatus>pass</CnAuditStatus>
</GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Request (JSON format)
https://api.dynadot.json/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid
Response (JSON format)
{
"GetCnAuditStatusResponse": {
"ResponseCode": "0",
"Status": "success",
"CnAuditStatus": "pass"
}
}
Get Account Balance Command
This command is only available in XML and JSON format:
Get Account Balance Request ParameterExplicación
Get Account Balance Request Parameter
Explicación
N/ANo se requiere ningún parámetro adicional
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetAccountBalanceResponse></GetAccountBalanceResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetAccountBalanceHeader></GetAccountBalanceHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetAccountBalanceContent></GetAccountBalanceContent>Contenido de respuesta
<Balance></Balance>Saldo de la cuenta
Get Account Balance Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_account_balance
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
<GetAccountBalanceHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetAccountBalanceHeader>
<GetAccountBalanceContent>
<BalanceList>
<Balance>
<Currency>USD</Currency>
<Amount>300.00</Amount>
</Balance>
</BalanceList>
</GetAccountBalanceContent>
</GetAccountBalanceResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_account_balance
Response (JSON format)
{
"GetAccountBalanceResponse": {
"ResponseCode": 0,
"Status": "success",
"BalanceList": [
{
"Currency": "USD",
"Amount": "300.00"
}
]
}
}
Comando Obtener listados
If calling get listings command, the following parameters should be included:
Parámetro de solicitud obtener listadosExplicación
Parámetro de solicitud obtener listados
Explicación
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
exclude_pending_sale (opcional)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetListingsResponse></GetListingsResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetListingsHeader></GetListingsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetListingsContent></GetListingsContent>Contenido de listado
<Listing></Listing>Contenido de item listado
<ListingId></ListingId>Id de listado
<Domain></Domain>nombre de dominio
<Price></Price>Precio
<InBoundLinks></InBoundLinks>Número de enlaces entrantes
<Age></Age>Edad
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Obtener listados
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey¤cy=usd&command=get_listings
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
<GetListingsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetListingsHeader>
<GetListingsContent>
<Listing>
<ListingId>id1</ListingId>
<Domain>domain_name1</Domain>
<Price>1</Price>
<InboundLinks>1</InboundLinks>
<Age>1</Age>
<PendingSaleLocked>No</PendingSaleLocked>
</Listing>
<Listing>
<ListingId>id2</ListingId>
<Domain>domain_name2</Domain>
<Price>2</Price>
<InboundLinks>2</InboundLinks>
<Age>2</Age>
<PendingSaleLocked>No</PendingSaleLocked>
</Listing>
</GetListingsContent>
</GetListingsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey¤cy=usd&command=get_listings
Response (JSON format)
{
"GetListingsResponse": {
"ResponseCode": 0,
"Status": "success",
"Listing": [
{
"ListingId": "id1",
"Domain": "domain_name1",
"Price": "1",
"InboundLinks": "1",
"Age": "1",
"PendingSaleLocked": "No"
},
{
"ListingId": "id2",
"Domain": "domain_name2",
"Price": "2",
"InboundLinks": "2",
"Age": "2",
"PendingSaleLocked": "No"
}
]
}
}
Comando Obtener elemento de listado
If calling get listing item command, the following parameters should be included:
Parámetro de solicitud de obtener elemento de listadoExplicación
Parámetro de solicitud de obtener elemento de listado
Explicación
domainThe domain name you want to get detail, only 1 domain can be entered per request
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetListingItemResponse></GetListingItemResponse>Nodo raiz de la respuesta del documento XMLXML documento
<GetListingItemHeader></GetListingItemHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetListingsItemContent></GetListingsItemContent>Contenido de listado
<Listing></Listing>Contenido de item listado
<ListingId></ListingId>Id de listado
<Domain></Domain>nombre de dominio
<Price></Price>Precio
<InBoundLinks></InBoundLinks>Número de enlaces entrantes
<Age></Age>Edad
Ejemplo de Obtener elemento de listado
Request (XML format)
http://api.dynadot.com/api3.xml?key=my_key&command=get_listing_item¤cy=usd&domain=domain_name
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
<GetListingsItemHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetListingsItemHeader>
<GetListingsItemContent>
<Listing>
<ListingId>id</ListingId>
<Domain>domain_name</Domain>
<Price>0</Price>
<InboundLinks>0</InboundLinks>
<Age>0</Age>
<PendingSaleLocked>No</PendingSaleLocked>
</Listing>
</GetListingsItemContent>
</GetListingsItemResponse>
Request (JSON format)
http://api.dynadot.com/api3.json?key=my_key&command=get_listing_item¤cy=usd&domain=domain_name
Response (JSON format)
{
"GetListingsItemResponse": {
"ResponseCode": 0,
"Status": "success",
"Listing": {
"ListingId": "id",
"Domain": "domain_name",
"Price": "0",
"InboundLinks": "0",
"Age": "0",
"PendingSaleLocked": "No"
}
}
}
Buy It Now Command
If calling buy it now command, the following parameters should be included:
Parámetro de solicitud Cómprelo ahoraExplicación
Parámetro de solicitud Cómprelo ahora
Explicación
domainThe domain you want to buy, only 1 domain can be entered per request
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<BuyItNowResponse></BuyItNowResponse>Nodo raiz de la respuesta del documento XMLXML documento
<BuyItNowHeader></BuyItNowHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<Message></Message>It should be "domain order created", only used when status is "success".
Ejemplo Cómprelo ahora
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=buy_it_now&domain=domain¤cy=currency
Response (XML format)
<BuyItNowResponse>
<BuyItNowHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</BuyItNowHeader>
<Message>domain order created</Message>
</BuyItNowResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=buy_it_now&domain=domain¤cy=currency
Response (JSON format)
{
"BuyItNowResponse":{
"ResponseCode":"0",
"Status":"success",
"Message":"domain order created"
}
}
Orden de información de cuenta
This command is only available in XML and JSON format:
Parámetro de orden de información de cuentaExplicación
Parámetro de orden de información de cuenta
Explicación
N/ANo se requiere ningún parámetro adicional
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<AccountInfoResponse></AccountInfoResponse>Nodo raíz del documento de respuesta XML
<AccountInfoHeader></AccountInfoHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<AccountInfoContent></AccountInfoContent>Contenido de respuesta
<AccountInfo></AccountInfo>información de cuenta
<Username></Username>Nombre de usuario
<ForumName></ForumName>Nombre del foro
<Contact></Contact>Información de contacto
<Organization></Organization>Organización
<Organization></Organization>Titulo de respuesta
<Name></Name>Tu nombre
<Email></Email>Correo electrónico
<PhoneCc></PhoneCc>Código de país del número de teléfono
<PhoneNum></PhoneNum>Número de teléfono
<Address1></Address1>Dirección 1
<Address2></Address2>Dirección 2
<City></City>Ciudad
<State></State>Estado
<ZipCode></ZipCode>Código Postal
<Country></Country>País
<CustomerSince></CustomerSince>Cliente desde
<AccountLock></AccountLock>Bloqueo de cuenta
<TotalSpending></TotalSpending>Gasto total
<PriceLevel></PriceLevel>Nivel de precios
<AccountBalance></AccountBalance>Saldo de la cuenta
<CustomTimeZone></CustomTimeZone>Zona horaria personalizada
<DefaultSettings></DefaultSettings>Configuración por defecto
<DefaultWhois></DefaultWhois>Whois por defecto
<DefaultRegistrant></DefaultRegistrant>Solicitante de registro predeterminado
<ContactId></ContactId>ID del Contacto
<DefaultAdmin></DefaultAdmin>Administrador predeterminado
<DefaultTechnical></DefaultTechnical>Data técnica predeterminada
<DefaultBilling></DefaultBilling>Facturación predeterminada
<Type></Type>Tipo de servidor de nombres
<WithAds></WithAds>Con publicidades o sin publicidades
Ejemplo de orden de información de cuenta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=account_info
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
<AccountInfoHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</AccountInfoHeader>
<AccountInfoContent>
<AccountInfo>
<Username>testname</Username>
<ForumName>test forum name</ForumName>
<Contact>
<Organization/>
<Name>testname test</Name>
<Email>[email protected]</Email>
<PhoneCc>1</PhoneCc>
<PhoneNum>555.555.5233</PhoneNum>
<FaxCc/>
<FaxNum/>
<Address1>1 test road</Address1>
<Address2/>
<City>Los Angeles</City>
<State>CA</State>
<ZipCode>90000</ZipCode>
<Country>US</Country>
</Contact>
<CustomerSince>1364888735253</CustomerSince>
<AccountLock>on</AccountLock>
<TotalSpending>$0.00</TotalSpending>
<PriceLevel>Regular Pricing</PriceLevel>
<AccountBalance>$70.02</AccountBalance>
<CustomTimeZone>PST</CustomTimeZone>
<DefaultSettings>
<DefaultWhois>
<DefaultRegistrant>
<ContactId>0</ContactId>
</DefaultRegistrant>
<DefaultAdmin>
<ContactId>0</ContactId>
</DefaultAdmin>
<DefaultTechnical>
<ContactId>0</ContactId>
</DefaultTechnical>
<DefaultBilling>
<ContactId>0</ContactId>
</DefaultBilling>
</DefaultWhois>
<DefaultNameServerSettings>
<Type>Dynadot Parking</Type>
<WithAds>yes</WithAds>
</DefaultNameServerSettings>
</DefaultSettings>
</AccountInfo>
</AccountInfoContent>
</AccountInfoResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=account_info
Response (JSON format)
{
"AccountInfoResponse": {
"ResponseCode": 0,
"Status": "success",
"AccountInfo": {
"Username": "testname",
"ForumName": "test forum name",
"Contact": {
"Organization": "",
"Name": "testname test",
"Email": "[email protected]",
"PhoneCc": "1",
"PhoneNum": "555.555.5233",
"FaxCc": "",
"FaxNum": "",
"Address1": "1 test road",
"Address2": "",
"City": "Los Angeles",
"State": "CA",
"ZipCode": "90000",
"Country": "US"
},
"CustomerSince": "1364888735253",
"AccountLock": "on",
"TotalSpending": "$0.00",
"PriceLevel": "Regular Pricing",
"AccountBalance": "$70.02",
"CustomTimeZone": "PST",
"DefaultSettings": {
"DefaultWhois": {
"DefaultRegistrant": {
"ContactId": "0"
},
"DefaultAdmin": {
"ContactId": "0"
},
"DefaultTechnical": {
"ContactId": "0"
},
"DefaultBilling": {
"ContactId": "0"
}
},
"DefaultNameServerSettings": {
"Type": "Dynadot Parking",
"WithAds": "yes"
}
}
}
}
}
Orden de asignar Whois por omisión
Si invoca el comando establecer Whois en forma predeterminada, se deben incluir los siguientes parámetros:
Parámetro de orden de asignar whois por omisiónExplicación
Parámetro de orden de asignar whois por omisión
Explicación
registrant_contactInformación del registrante del dominio
admin_contactInformación del administrador del dominio
technical_contactInformación técnica del dominio
billing_contactInformación de facturación del dominio
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Nodo raíz del documento de respuesta XML
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar whois por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_whois®istrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (XML format)
<SetDefaultWhoisResponse>
<SetDefaultWhoisHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_whois®istrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (JSON format)
{
"SetDefaultWhoisResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Servidores de Nombres Predeterminados
Si invoca el comando establecer servidores de nombres predeterminados, se deben incluir los siguientes parámetros:
Parámetros Solicitud Establecer Servidores de Nombres PredeterminadosExplicación
Parámetros Solicitud Establecer Servidores de Nombres Predeterminados
Explicación
ns0 - ns12Los servidores de nombres que desea crear
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultNsResponse></SetDefaultNsResponse>Etiqueta de la respuesta establecer servidores de nombres predeterminados, es el nodo raíz del documento de respuesta XML
<SetDefaultNsHeader></SetDefaultNsHeader>Etiqueta de encabezado de establecer servidores de nombres por defecto
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<SetDefaultNsContent></SetDefaultNsContent>Etiqueta de contenido de establecer servidores de nombres por defecto, sólo se utiliza cuando el estado es "success"
<Servers></Servers>La información de los servidores que desea establecer
<Server></Server>Cada servidor
<ServerName></ServerName>Nombre del servidor
<ServerId></ServerId>Identificación de servidor
Ejemplo Crear Servidor de Nombres Predeterminado
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Response (XML format)
<SetDefaultNsResponse>
<SetDefaultNsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultNsHeader>
<SetDefaultNsContent>
<Servers>
<Server>
<ServerName>ns1.hosts.com</ServerName>
<ServerId>0</ServerId>
</Server>
<Server>
<ServerName>ns2.host.com</ServerName>
<ServerId>1</ServerId>
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
<Server>
<ServerName />
<ServerId />
</Server>
</Servers>
</SetDefaultNsContent>
</SetDefaultNsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com
Response (JSON format)
{
"SetDefaultNsResponse":{
"ResponseCode":"0",
"Status":"success",
"SetDefaultNsContent":{
"Servers":[
{
"ServerName":"ns1.hosts.com",
"ServerId":"0"
},
{
"ServerName":"ns2.host.com",
"ServerId":"1"
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
}
]
}
}
}
Orden de asignar estacionamiento por omisión
Si estás llamando la orden de asignar estacionamiento por omisión, hay que incluir los siguientes parámetros:
Parámetros de Solicitud Establecer Parking PredeterminadoExplicación
Parámetros de Solicitud Establecer Parking Predeterminado
Explicación
with_ads (opcional)Si no desea anuncios de terceros, puede utilizar este parámetro señalando "no", el valor por defecto es "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultParkingResponse></SetDefaultParkingResponse>Nodo raíz del documento de respuesta XML
<SetDefaultParkingHeader></SetDefaultParkingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar estacionamiento por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_parking&folder_id=0&with_ads=no
Response (XML format)
<SetDefaultParkingResponse>
<SetDefaultParkingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_parking&folder_id=0&with_ads=no
Response (JSON format)
{
"SetDefaultParkingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar reenvío por omisión
Si estás llamando la orden de asignar reenvío por omisión, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar reenvío por omisiónExplicación
Parámetro de orden de asignar reenvío por omisión
Explicación
forward_urlLa URL a la que desea que se redireccione su dominio. Tenga en cuenta que el parámetro debe estar codificado para que la llamada a la API se interprete correctamente. is_temp (opcional)Estado de redireccionamiento de su dominio que desea, el valor por defecto es "temporary", si desea un redireccionamiento permanente, utilice este parámetro con "no"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Nodo raíz del documento de respuesta XML
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar reenvío por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com
Response (XML format)
<SetDefaultForwardingResponse>
<SetDefaultForwardingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com
Response (JSON format)
{
"SetDefaultForwardingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar sigilo por omisión
Si estás llamando la orden de asignar sigilo por omisión, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar sigilo por omisiónExplicación
Parámetro de orden de asignar sigilo por omisión
Explicación
stealth_urlLa URL a la que desea que se redireccione su dominio. Tenga en cuenta que el parámetro debe estar codificado para que la llamada a la API se interprete correctamente. stealth_title (opcional)El titulo de la página
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultStealthResponse></SetDefaultStealthResponse>Nodo raíz del documento de respuesta XML
<SetDefaultStealthHeader></SetDefaultStealthHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Configuración en Modo Oculto Predeterminado
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com
Response (XML format)
<SetDefaultStealthResponse>
<SetDefaultStealthHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com
Response (JSON format)
{
"SetDefaultStealthResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar hosting por omisión
Si estás llamando la orden de asignar hosting por omisión, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar hosting por omisiónExplicación
Parámetro de orden de asignar hosting por omisión
Explicación
hosting_typeTipo de alojamiento predeterminado que desea, puede seleccionar entre "advanced" y "basic"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultHostingResponse></SetDefaultHostingResponse>Nodo raíz del documento de respuesta XML
<SetDefaultHostingHeader></SetDefaultHostingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar hosting por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_hosting&hosting_type=advanced
Response (XML format)
<SetDefaultHostingResponse>
<SetDefaultHostingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_hosting&hosting_type=advanced
Response (JSON format)
{
"SetDefaultHostingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar DNS por omisión
SI estás llamando la orden de asignar DNS por omisión, hay que incluir los siguientes parámetros:
(Este comando está desactualizado y no se recomienda, en su reemplazo utilice el comando Configurar DNS2 Predeterminado)
Parámetro de orden de asignar DNS por omisiónExplicación
Parámetro de orden de asignar DNS por omisión
Explicación
main_record_typetipo de registro principal
main_recordEspecifica un registro DNS para tu dominio
main_txt (opcional)Especificar un registro TXT para su dominio. Si su main_record_type (tipo de registro principal) es aaaa y se ha especificado un main_record2, se puede establecer hasta 3 main_txts (textos principales), de lo contrario, puede configurar hasta 4 main_txts (textos principales).
main_record2Main record 2 (registro principal 2), sólo se utiliza cuando "main_record_type" es "aaaa". Su valor debe estar en formato ipv4.
subdomain0 - subdomain99 (opcional)Registros de subdominio
sub_record_type0 - sub_record_type99 (opcional)Tipo de registro de subdominio
sub_record0 - sub_record99 (opcional)Dirección IP o host de destino
mx_host0 - mx_host2 (opcional)Especificar el host de correo electrónico para su dominio, distance0 es la prioridad más alta.
mx_distance0 - mx_distance2 (opcional)Distance0 es la prioridad más alta
ttl (opcional)Tiempo de vida
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nodo raíz del documento de respuesta XML
<SetDefaultDnsHeader></SetDefaultDnsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar DNS por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (XML format)
<SetDefaultDnsResponse>
<SetDefaultDnsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (JSON format)
{
"SetDefaultDnsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Configurar el comando DNS2 predeterminado
SI estás llamando la orden de asignar DNS por omisión, hay que incluir los siguientes parámetros:
Configurar el Parámetro de Solicitud de DNS2 PredeterminadoExplicación
Configurar el Parámetro de Solicitud de DNS2 Predeterminado
Explicación
main_record_type0 - main_record_type19tipo de registro principal
main_record0 - main_record19Especifique el registro DNS para su dominio.
main_recordx0 - main_recordx19Se requiere distancia Mx, tipo de reenvío, título de redireccionamiento en modo oculto o alias de correo electrónico cuando main_record (registro principal) es "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
subdomain0 - subdomain99 (opcional)Registros de subdominio
sub_record_type0 - sub_record_type99 (opcional)Tipo de registro de subdominio
sub_record0 - sub_record99 (opcional)Dirección IP del subdominio o host de destino
sub_recordx0 - subdo_recordx99Distancia mx, tipo de redireccionamiento, título de redireccionamiento en modo oculto o alias de correo electrónico, necesario cuando el tipo de sub registro sea "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
ttl (opcional)Tiempo de vida
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultDnsResponse></SetDefaultDnsResponse>Nodo raíz del documento de respuesta XML
<SetDefaultDnsHeader></SetDefaultDnsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Configurar DNS2 predeterminado
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (XML format)
<SetDefaultDnsResponse>
<SetDefaultDnsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (JSON format)
{
"SetDefaultDnsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar reenvío de correo electrónico por omisión
Si estás llamando la orden de asignar reenvío de correo electrónico por omisión, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar reenvío de correo electrónico por omisiónExplicación
Parámetro de orden de asignar reenvío de correo electrónico por omisión
Explicación
forward_typeTipo de reenvío, puede ser "donot": No reenviar el correo electrónico, "mx": Enviar correo electrónico a otro servidor de correo (registro MX), "forward": Remitir correo electrónico a otro servidor de correo
username0 - username9Nombre de usuario, sólo se utiliza cuando "forward_type" es "forward"
exist_email0 - exist_email9Dirección de correo electrónico existente, sólo se utiliza cuando "forward_type" es "forward"
mx_host0 - mx_host2Host de correo, sólo se utiliza cuando "forward_type" es "mx"
mx_distance0 - mx_distance2Distance0 es la prioridad más alta, sólo se utiliza cuando "forward_type" es "mx"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Nodo raíz del documento de respuesta XML
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar reenvío de correo electrónico por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]
Response (XML format)
<SetDefaultEmailForwardingResponse>
<SetDefaultEmailForwardingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]
Response (JSON format)
{
"SetDefaultEmailForwardingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Borrar Ajuste Predeterminado
Si invoca el comando establecer borrar ajuste predeterminado, se deben incluir los siguientes parámetros:
Parámetros Solicitud Establecer Borrar Ajuste PredeterminadoExplicación
Parámetros Solicitud Establecer Borrar Ajuste Predeterminado
Explicación
serviceEl servicio que quieres eliminar puede ser "redireccionar", "modo oculto", "redireccionar correo electrónico", "dns" y " servidores de nombre "
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Nodo raíz del documento de respuesta XML
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de eliminar ajuste por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_default_setting&service=nameservers
Response (XML format)
<SetClearDefaultSettingResponse>
<SetClearDefaultSettingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_clear_default_setting&service=nameservers
Response (JSON format)
{
"SetClearDefaultSettingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de asignar opción de renovación por omisión
Si estás llamando la orden de asignar opción de renovación por omisión, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar opción de renovación por omisiónExplicación
Parámetro de orden de asignar opción de renovación por omisión
Explicación
renew_optionPuede ser "donot", "auto", "reset"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Nodo raíz del documento de respuesta XML
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar opción de renovación por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_default_renew_option&renew_option=auto
Response (XML format)
<SetDefaultRenewOptionResponse>
<SetDefaultRenewOptionHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_default_renew_option&renew_option=auto
Response (JSON format)
{
"SetDefaultRenewOptionResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de crear carpeta
Si estás llamando la orden de crear carpeta, hay que incluir los siguientes parámetros:
Parámetro de orden de crear carpetaExplicación
Parámetro de orden de crear carpeta
Explicación
folder_nameNombre de la carpeta que deseas crear
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<FolderCreateResponse></FolderCreateResponse>Nodo raíz del documento de respuesta XML
<FolderCreateHeader></FolderCreateHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<FolderCreateContent></FolderCreateContent>Contenido de respuesta
<FolderName></FolderName>nombre de carpeta
<FolderId></FolderId>ID de la nueva carpeta
Ejemplo de crear carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=create_folder&folder_name=new
Response (XML format)
<FolderCreateResponse>
<FolderCreateHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</FolderCreateHeader>
<FolderCreateContent>
<FolderName>new</FolderName>
<FolderId>1</FolderId>
</FolderCreateContent>
</FolderCreateResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=create_folder&folder_name=new
Response (JSON format)
{
"FolderCreateResponse":{
"ResponseCode":"0",
"Status":"success",
"FolderCreateContent":{
"FolderName":"new",
"FolderId":"1"
}
}
}
Comando Eliminar Carpeta
Si invoca el comando establecer Whois, se debe incluir los siguientes parámetros:
Parámetros de Solicitud Eliminar CarpetaExplicación
Parámetros de Solicitud Eliminar Carpeta
Explicación
folder_idLas ID de las carpetas que desea eliminar, asegúrese de que estén separadas por comas
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DeleteFolderResponse></DeleteFolderResponse>Nodo raíz del documento de respuesta XML
<DeleteFolderHeader></DeleteFolderHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Eliminar Carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=delete_folder&folder_id=0,1
Response (XML format)
<DeleteFolderResponse>
<DeleteFolderHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</DeleteFolderHeader>
</DeleteFolderResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=delete_folder&folder_id=0,1
Response (JSON format)
{
"DeleteFolderResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Establezca el Comando de la Carpeta Whois
Si invoca el comando crear carpeta Whois, se deben incluir los siguientes parámetros:
Parámetro de orden de asignar whois de carpetaExplicación
Parámetro de orden de asignar whois de carpeta
Explicación
folder_idID de la carpeta que desea crear
registrant_contactInformación del registrante del dominio
admin_contactInformación del administrador del dominio
technical_contactInformación técnica del dominio
billing_contactInformación de facturación del dominio
enable (opcional)Si desea aplicar esta configuración de Whois a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar esta configuración de Whois de todos los dominios de esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderWhoisResponse></SetFolderWhoisResponse>Nodo raíz del documento de respuesta XML
<SetFolderWhoisHeader></SetFolderWhoisHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar whois de carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_whois&folder_id=0®istrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (XML format)
<SetFolderWhoisResponse>
<SetFolderWhoisHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_whois&folder_id=0®istrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0
Response (JSON format)
{
"SetFolderWhoisResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Carpeta de Servidores de Nombres
Si invoca el comando establecer carpeta de servidores de nombres, se deben incluir los siguientes parámetros:
Parámetro Solicitud Establecer Carpeta de Servidores de NombresExplicación
Parámetro Solicitud Establecer Carpeta de Servidores de Nombres
Explicación
fold_idID de la carpeta que desea crear, sólo se puede crear 1 carpeta por solicitud
ns0 - ns12Los servidores de nombres para establecer su dominio a utilizar, puede especificar un máximo de 13 servidores de nombres, pero estos ya deben estar en su cuenta
enable (opcional)Si desea aplicar esta configuración de los servidores de nombres a los futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar la configuración del servidor de nombres de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderNsResponse></SetFolderNsResponse>Etiqueta de respuesta de establecer carpeta de servidor de nombres, es el nodo raíz del documento de respuesta XML
<SetFolderNsHeader></SetFolderNsHeader>Etiqueta de encabezado de respuesta de establecer carpeta de servidor de nombres
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<SetFolderNsContent></SetFolderNsContent>Etiqueta de contenido de respuesta de establecer carpeta de servidor de nombres, sólo se utiliza cuando el estatus es "success"
<Servers></Servers>La información de los servidores que desea establecer
<Server></Server>Cada servidor
<ServerName></ServerName>Nombre del servidor
<ServerId></ServerId>ID del servidor
Ejemplo Establecer Carpeta de Servidores de Nombres
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Response (XML format)
0
success
ns1.hosts.com
0
ns2.host.com
1
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes
Response (JSON format)
{
"SetFolderNsResponse":{
"ResponseCode":"0",
"Status":"success",
"SetFolderNsContent":{
"Servers":[
{
"ServerName":"ns1.hosts.com",
"ServerId":"0"
},
{
"ServerName":"ns2.host.com",
"ServerId":"1"
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
},
{
"ServerName":"",
"ServerId":""
}
]
}
}
}
Orden de asignar estacionamiento de carpeta
Si estás llamando la orden de asignar estacionamiento de carpeta, hay que incluir los siguientes parámetros:
Parámetro de orden de asignar estacionamiento de carpetaExplicación
Parámetro de orden de asignar estacionamiento de carpeta
Explicación
folder_idID de la carpeta que desea crear, sólo se puede crear 1 carpeta por solicitud
with_ads (opcional)Si no desea anuncios de terceros, puede utilizar este parámetro señalando "no", el valor por defecto es "yes"
enable (opcional)Si desea aplicar esta configuración de parking a futuros dominios que haya trasladado a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar la configuración de parking de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderParkingResponse></SetFolderParkingResponse>Nodo raíz del documento de respuesta XML
<SetFolderParkingHeader></SetFolderParkingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar estacionamiento de carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no
Response (XML format)
<SetFolderParkingResponse>
<SetFolderParkingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderParkingHeader>
</SetFolderParkingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no
Response (JSON format)
{
"SetFolderParkingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Redireccionamiento en Carpeta
Si invoca el comando establecer reenvío en carpeta, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Establecer Reenvío en CarpetaExplicación
Parámetros de Solicitud Establecer Reenvío en Carpeta
Explicación
folder_idID de la carpeta que desea crear
forward_urlLa URL a la que desea que se redireccione su dominio. Tenga en cuenta que el parámetro debe estar codificado para que la llamada a la API se interprete correctamente. is_temp (opcional)Estado de redireccionamiento de su dominio que desea, el valor por defecto es "temporary", si desea un redireccionamiento permanente, utilice este parámetro con "no"
enable (opcional)Si desea aplicar esta configuración de redireccionamiento a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar la configuración de redireccionamiento de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderForwardingResponse></SetFolderForwardingResponse>Nodo raíz del documento de respuesta XML
<SetFolderForwardingHeader></SetFolderForwardingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Establecer Redireccionamiento en Carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes
Response (XML format)
<SetFolderForwardingResponse>
<SetFolderForwardingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes
Response (JSON format)
{
"SetFolderForwardingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Carpeta Modo Oculto
Si invoca el comando establecer carpeta modo oculto, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Establecer Carpeta Modo OcultoExplicación
Parámetros de Solicitud Establecer Carpeta Modo Oculto
Explicación
folder_idID de la carpeta que desea crear
stealth_urlLa URL a la que desea que se redireccione su dominio. Tenga en cuenta que el parámetro debe estar codificado para que la llamada a la API se interprete correctamente. stealth_title (opcional)El titulo de la página
enable (opcional)Si desea aplicar esta configuración de modo oculto a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar la configuración de modo oculto de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderStealthResponse></SetFolderStealthResponse>Nodo raíz del documento de respuesta XML
<SetFolderStealthHeader></SetFolderStealthHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de asignar sigilo por omisión
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes
Response (XML format)
<SetFolderStealthResponse>
<SetFolderStealthHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderStealthHeader>
</SetFolderStealthResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes
Response (JSON format)
{
"SetFolderStealthResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Carpeta de Alojamiento
Si invoca el comando establecer carpeta de alojamiento, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Establecer Carpeta de AlojamientoExplicación
Parámetros de Solicitud Establecer Carpeta de Alojamiento
Explicación
folder_idID de la carpeta que desea crear
hosting_typeTipo de alojamiento que desea, puede seleccionar "advanced" y "basic"
enable (opcional)Si desea aplicar esta configuración de alojamiento a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
even (opcional)Si desea sincronizar la configuración de alojamiento de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderHostingResponse></SetFolderHostingResponse>Nodo raíz del documento de respuesta XML
<SetFolderHostingHeader></SetFolderHostingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Establecer Carpeta de Alojamiento
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Response (XML format)
<SetFolderHostingResponse>
<SetFolderHostingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderHostingHeader>
</SetFolderHostingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes
Response (JSON format)
{
"SetFolderHostingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Configurar Carpeta DNS
Si invoca el comando configurar carpeta DNS, se deben incluir los siguientes parámetros:
(Este comando está desactualizado y no se recomienda, en su lugar utilice el comando Configurar Carpeta DNS2)
Parámetros de Solicitud Establecer Carpeta DNSExplicación
Parámetros de Solicitud Establecer Carpeta DNS
Explicación
folder_idID de la carpeta que desea crear
main_record_typetipo de registro principal
main_recordEspecifica un registro DNS para tu dominio
main_recordEspecifica un registro DNS para tu dominio
with_ads (opcional)Especificar un registro TXT para su dominio. Si su main_record_type (tipo de registro principal) es aaaa y se ha especificado un main_record2, se puede establecer hasta 3 main_txts (textos principales), de lo contrario, puede configurar hasta 4 main_txts (textos principales).
main_record2Main record 2 (registro principal 2), sólo se utiliza cuando "main_record_type" es "aaaa". Su valor debe estar en formato ipv4.
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)Tipo de registro de subdominio
sub_record0 - sub_record99 (opcional)Dirección IP o host de destino
mx_host0 - mx_host2 (opcional)Especificar el host de correo electrónico para su dominio, distance0 es la prioridad más alta.
mx_distance0 - mx_distance2 (opcional)Distance0 es la más alta prioridad
ttl (opcional)Tiempo de vida
enable (opcional)Si desea aplicar esta configuración DNS a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar esta configuración del servidor DNS de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderDnsResponse></SetFolderDnsResponse>Nodo raíz del documento de respuesta XML
<SetFolderDnsHeader></SetFolderDnsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Configurar Carpeta DNS
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (XML format)
<SetFolderDnsResponse>
<SetFolderDnsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1
Response (JSON format)
{
"SetFolderDnsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Configurar Carpeta Comando DNS2
Si llama al comando configurar carpeta DNS2, se deben incluir los siguientes parámetros:
Configurar Párametro de Solicitud de Carpeta DNS2Explicación
Configurar Párametro de Solicitud de Carpeta DNS2
Explicación
folder_idID de la carpeta que desea crear
main_record_type0 - main_record_type19El tipo de registro principal debe ser "a", "aaaa", "cname", "forward", "txt", "mx", "stealth", "email"
main_record0 - main_record19Especifique el registro DNS para su dominio.
main_recordx0 - main_recordx19Se requiere distancia mx, tipo de reenvío, título de redireccionamiento en modo oculto o alias de correo electrónico cuando main_record_type (tipo de registro principal) es "forward", "mx", "stealth", "email"
subdomain0 - subdomain99 (opcional)Subdomain records (opcional)
sub_record_type0 - sub_record_type99 (opcional)El tipo de registros de subdominio debe ser "a", "aaaa", "cname", "forward", "txt", "srv", "mx", "stealth", "email"
sub_record0 - sub_record99 (opcional)Dirección IP o host de destino
sub_recordx0 - sub_recordx99 (opcional)Distancia mx, tipo de redireccionamiento, título de redireccionamiento en modo oculto o alias de correo electrónico, necesarios cuando sub_record_type es "forward", "mx", "stealth", "email"
ttl (opcional)Tiempo de vida
enable (opcional)Si desea aplicar esta configuración DNS a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar esta configuración del servidor DNS de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderDnsResponse></SetFolderDnsResponse>Nodo raíz del documento de respuesta XML
<SetFolderDnsHeader></SetFolderDnsHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Configurar Carpeta DNS2
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (XML format)
<SetFolderDnsResponse>
<SetFolderDnsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1
Response (JSON format)
{
"SetFolderDnsResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Carpeta para Reenvío de Correos
Si invoca el comando establecer carpeta para reenvío de correos, se deben incluir los siguientes parámetros:
Parámetros Solicitud Establecer Carpeta para Reenvío de CorreosExplicación
Parámetros Solicitud Establecer Carpeta para Reenvío de Correos
Explicación
domainEl nombre de dominio que desea configurar, se pueden configurar 100 dominios por solicitud, asegúrese de que estén separados por comas
folder_idID de la carpeta que desea crear
forward_typeTipo de reenvío, puede ser "donot": No reenviar el correo electrónico, "mx": Enviar correo electrónico a otro servidor de correo (registro MX), "forward": Remitir correo electrónico a otro servidor de correo
username0 - username9Nombre de usuario, sólo se utiliza cuando "forward_type" es "forward"
exist_email0 - exist_email9Dirección de correo electrónico existente, sólo se utiliza cuando "forward_type" es "forward"
mx_host0 - mx_host2Host de correo, sólo se utiliza cuando "forward_type" es "mx"
mx_distance0 - mx_distance2Distance0 es la prioridad más alta, sólo se utiliza cuando "forward_type" es "mx"
enable (opcional)Si desea aplicar esta configuración a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar esta configuración de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Nodo raíz del documento de respuesta XML
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Establecer Carpeta para Reenvío de Correos
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]
Response (XML format)
<SetFolderEmailForwardingResponse>
<SetFolderEmailForwardingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]
Response (JSON format)
{
"SetFolderEmailForwardingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Borrar Configuración de Carpeta
Si invoca el comando establecer borrado de configuración de carpeta, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Establecer Borrar Configuración de CarpetaExplicación
Parámetros de Solicitud Establecer Borrar Configuración de Carpeta
Explicación
folder_idID de la carpeta que desea crear
serviceEl servicio que quieres eliminar puede ser "redireccionar", "modo oculto", "redireccionar correo electrónico", "dns" y " servidores de nombre "
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Nodo raíz del documento de respuesta XML
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Establecer Borrado de Configuración de Carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers
Response (XML format)
<SetClearFolderSettingResponse>
<SetClearFolderSettingHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers
Response (JSON format)
{
"SetClearFolderSettingResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Crear Nombre de Carpeta
Si invoca el comando crear nombre de carpeta, se deben incluir los siguientes parámetros:
Parámetro Solicitud Crear Nombre de CarpetaExplicación
Parámetro Solicitud Crear Nombre de Carpeta
Explicación
folder_idID de la carpeta que desea crear
folder_nameNuevo nombre de carpeta
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<SetFolderNameResponse></SetFolderNameResponse>Nodo raíz del documento de respuesta XML
<SetFolderNameHeader></SetFolderNameHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Establecer Nombre de Carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_name&folder_id=0&folder_name=new
Response (XML format)
<SetFolderNameResponse>
<SetFolderNameHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderNameHeader>
</SetFolderNameResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_name&folder_id=0&folder_name=new
Response (JSON format)
{
"SetFolderNameResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Establecer Opción de Renovación de Carpeta
Si invoca el comando establecer opción de renovación de carpeta, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Establecer Opción de Renovación de CarpetaExplicación
Parámetros de Solicitud Establecer Opción de Renovación de Carpeta
Explicación
folder_idID de la carpeta que desea crear, sólo se puede crear 1 carpeta por solicitud
renew_optionThe renew option you want to set to the folder; it can be "donot", "auto" or "reset"
enable (opcional)Si desea aplicar esta configuración de renovación a futuros dominios que traslade a esta carpeta, puede utilizar este parámetro con "yes"
sync (opcional)Si desea sincronizar la configuración de renovación de todos los dominios en esta carpeta, puede utilizar este parámetro con "yes"
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<Response></Response>Nodo raíz del documento de respuesta XML
<ResponseHeader></ResponseHeader>Encabezado de Respuesta
<ResponseCode></ResponseCode>Código de respuesta, "0" para correctamente, "-1" para falló
<Error></Error>Información de error, sólo se utiliza cuando el código de respuesta es "-1"
Ejemplo Establecer Opción de Renovación de Carpeta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_renew_option&folder_id=0&renew_option=auto
Response (XML format)
<SetFolderRenewOptionResponse>
<SetFolderRenewOptionHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=set_folder_renew_option&folder_id=0&renew_option=auto
Response (JSON format)
{
"SetFolderRenewOptionResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Comando Lista de Carpetas
This command is only available in XML and JSON format:
Parámetros de Solicitud Lista de CarpetasExplicación
Parámetros de Solicitud Lista de Carpetas
Explicación
N/ANo se requiere ningún parámetro adicional
<FolderListResponse></FolderListResponse>Nodo raíz del documento de respuesta XML
<FolderListHeader></FolderListHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<FolderListContent></FolderListContent>Contenido de respuesta
<FolderList></FolderList>Lista de carpetas
<List></List>
<Folder></Folder>
<FolderId></FolderId>ID de Carpeta
<FolderName></FolderName>Nombre de carpeta
<DefaultWhois></DefaultWhois>Whois por defecto
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Estado de activación Whois Predeterminado
<DefaultRegistrant></DefaultRegistrant>Solicitante de registro predeterminado
<ContactId></ContactId>ID de Contacto
<DefaultAdmin></DefaultAdmin>Administrador predeterminado
<DefaultTechnical></DefaultTechnical>Información técnica predeterminada
<DefaultBilling></DefaultBilling>Información de facturación predeterminada
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Estado de activación de servidor de nombres predeterminado
<NameServerSettings></NameServerSettings>Configuración del servidor de nombres
<Type></Type>Tipo de servidor de nombres
<WithAds></WithAds>Con publicidades o sin publicidades
<DefaultRenewOption></DefaultRenewOption>Opción Renovación Predeterminada
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Estado de activación opción renovación predeterminada
<RenewOption></RenewOption>Opción de renovación
<DefaultTransferLock></DefaultTransferLock>Bloqueo de transferencia por defecto
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Estado de activación bloqueo de transferencia por defecto
<LockStatus></LockStatus>Estado de bloqueo
Ejemplo de Lista de Carpetas
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=folder_list
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<FolderListResponse>
<FolderListHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</FolderListHeader>
<FolderListContent>
<FolderList>
<List>
<Folder>
<FolderId>0</FolderId>
<FolderName>new</FolderName>
<DefaultWhois>
<DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
<DefaultRegistrant>
<ContactId>0</ContactId>
</DefaultRegistrant>
<DefaultAdmin>
<ContactId>0</ContactId>
</DefaultAdmin>
<DefaultTechnical>
<ContactId>0</ContactId>
</DefaultTechnical>
<DefaultBilling>
<ContactId>0</ContactId>
</DefaultBilling>
</DefaultWhois>
<DefaultNameServers>
<DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
<NameServerSettings>
<Type>Dynadot Parking</Type>
<WithAds>Yes</WithAds>
</NameServerSettings>
</DefaultNameServers>
<DefaultRenewOption>
<DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
<RenewOption>no renew option</RenewOption>
</DefaultRenewOption>
<DefaultTransferLock>
<DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
<LockStatus>locked</LockStatus>
</DefaultTransferLock>
</Folder>
</List>
</FolderList>
</FolderListContent>
</FolderListResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=folder_list
Response (JSON format)
{
"FolderListResponse": {
"ResponseCode": 0,
"Status": "success",
"FolderList": [
{
"FolderId": "0",
"FolderName": "new",
"DefaultWhois": {
"DefaultWhoisEnableStatus": "disable",
"DefaultRegistrant": {
"ContactId": "0"
},
"DefaultAdmin": {
"ContactId": "0"
},
"DefaultTechnical": {
"ContactId": "0"
},
"DefaultBilling": {
"ContactId": "0"
}
},
"DefaultNameServers": {
"DefaultTransferLockEnableStatus": "disable",
"NameServerSettings": {
"Type": "Dynadot Parking",
"WithAds": "Yes"
}
},
"DefaultRenewOption": {
"DefaultRenewOptionEnableStatus": "disable",
"RenewOption": "no renew option"
},
"DefaultTransferLock": {
"DefaultTransferLockEnableStatus": "disable",
"LockStatus": "locked"
}
}
]
}
}
Orden de agregar solicitud de backorder
Si estás llamando la orden de agregar solicitud de backorder, hay que incluir los siguientes parámetros:
Parámetro de orden de agregar solicitud de backorderExplicación
Parámetro de orden de agregar solicitud de backorder
Explicación
domainDominio(s) que desea añadir y acepta pagar si Dynadot los consigue, se pueden añadir 100 dominios por solicitud, deben estar separados por comas
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<AddBackorderRequestResponse></AddBackorderRequestResponse>Nodo raíz del documento de respuesta XML
<AddBackorderRequestHeader></AddBackorderRequestHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de agregar solicitud de backorder
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Response (XML format)
<AddBackorderRequestResponse>
<AddBackorderRequestHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org
Response (JSON format)
{
"AddBackorderRequestResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de eliminar solicitud de backorder
Si estás llamando la orden de eliminar solicitud de backorder, hay que incluir los siguientes parámetros:
Parámetro de orden de eliminar solicitud de backorderExplicación
Parámetro de orden de eliminar solicitud de backorder
Explicación
domainDominio(s) que desea eliminar de la lista de solicitudes de pedidos pendientes, se pueden eliminar 100 dominios por solicitud, deben estar separados por comas
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Nodo raíz del documento de respuesta XML
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de orden de eliminar solicitud de backorder
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=delete_backorder_request&domain=domaindropp.com
Response (XML format)
<DeleteBackorderRequestResponse>
<DeleteBackorderRequestHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=delete_backorder_request&domain=domaindropp.com
Response (JSON format)
{
"DeleteBackorderRequestResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Orden de lista de solicitudes de backorder
Al invocar el comando lista de solicitudes de pedidos pendientes se presentará una lista de solicitudes de pedidos pendientes de la cuenta especificada. Si invoca este comando, deben incluirse los siguientes parámetros:
Parámetro de orden de lista de solicitudes de backorderExplicación
Parámetro de orden de lista de solicitudes de backorder
Explicación
startDateFecha de inicio de liberación de subasta que desea solicitar, aaaa-mm-dd, ejemplo 2015-05-05
endDateFecha de finalización de liberación de subasta que desea solicitar, aaaa-mm-dd, ejemplo 2015-05-05
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<BackorderRequestListResponse></BackorderRequestListResponse>Nodo raíz del documento de respuesta XML
<BackorderRequestListHeader></BackorderRequestListHeader>Titulo de respuesta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<BackorderRequestListContent></BackorderRequestListContent>Contenido de respuesta
<BackorderRequestList></BackorderRequestList>Lista de solicitudes de backorder
<BackorderRequest></BackorderRequest>Solicitud de backorder
<Domain></Domain>Dominio de tu lista
<CutoffTime></CutoffTime>Fecha de corte para eliminar una solicitud en tiempo Unix (milisegundos desde la medianoche UTC de enero, 1, 1970)
<BackorderRequestStatus></BackorderRequestStatus>Estatus en el proceso de capturar dominios dropping
Ejemplo de orden de lista de solicitudes de backorder
Request (XML format)
http://api.dynadot.com/api3.xml?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
<BackorderRequestListHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</BackorderRequestListHeader>
<BackorderRequestListContent>
<BackorderRequestList>
<BackorderRequest>
<DomainName>testdrop.com</DomainName>
<CutoffTime>1403914140000</CutoffTime>
<BackorderRequestStatus>Active</BackorderRequestStatus>
</BackorderRequest>
<BackorderRequest>
<DomainName>testdrop3.com</DomainName>
<CutoffTime>1403914140000</CutoffTime>
<BackorderRequestStatus>Active</BackorderRequestStatus>
</BackorderRequest>
<BackorderRequest>
<DomainName>testdrop4.com</DomainName>
<CutoffTime>1403914140000</CutoffTime>
<BackorderRequestStatus>Active</BackorderRequestStatus>
</BackorderRequest>
<BackorderRequest>
<DomainName>testdrop5.com</DomainName>
<CutoffTime>1403914140000</CutoffTime>
<BackorderRequestStatus>Active</BackorderRequestStatus>
</BackorderRequest>
</BackorderRequestList>
</BackorderRequestListContent>
</BackorderRequestListResponse>
Request (CSV format)
http://api.dynadot.com/api3.html?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Response (CSV format)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
Request (JSON format)
http://api.dynadot.com/api3.json?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20
Response (JSON format)
{
"BackorderRequestListResponse": {
"ResponseCode": 0,
"Status": "success",
"BackorderRequestList": [
{
"DomainName": "testdrop.com",
"CutoffTime": "1403914140000",
"BackorderRequestStatus": "Active"
},
{
"DomainName": "testdrop3.com",
"CutoffTime": "1403914140000",
"BackorderRequestStatus": "Active"
},
{
"DomainName": "testdrop4.com",
"CutoffTime": "1403914140000",
"BackorderRequestStatus": "Active"
},
{
"DomainName": "testdrop5.com",
"CutoffTime": "1403914140000",
"BackorderRequestStatus": "Active"
}
]
}
}
Comando Obtener Subastas Abiertas
Al invocar el comando obtener subastas abiertas se presentará una lista de subastas que se están llevando a cabo. Si invoca este comando, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Obtener Subastas AbiertasExplicación
Parámetros de Solicitud Obtener Subastas Abiertas
Explicación
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
type (opcional)The auction type you want to see, it should be "expired", "user", or "backorder", if you want to get more than one auction types, you can use "," to split each auction type
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Etiqueta de respuesta de obtener subastas abiertas, es el nodo raíz del documento de respuesta XML
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Encabezado obtener subastas abiertas
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Etiqueta de contenido de obtener subastas abiertas, sólo se utiliza cuando el estado es "success"
<Auction></Auction>Etiqueta de ítem de subasta, sólo se utiliza cuando el estado es "success"
<AuctionId></AuctionId>ID de subasta
<Domain></Domain>Nombre de dominio de la subasta
<BidPrice></BidPrice>Precio de compra actual de la subasta
<BidPriceCurrency></BidPriceCurrency>Moneda del precio de compra
<Bids></Bids>Número de ofertas para subasta
<EndTime></EndTime>Hora de finalización de la subasta
<EndTimestamp></EndTimestamp>Fecha de finalización de la subasta en tiempo Unix (milisegundos desde la medianoche UTC de enerO 1, 1970)
<Revenue></Revenue>Ingresos de la subasta
<RevenueCurrency></RevenueCurrency>Moneda de los ingresos
<Visitors></Visitors>Visitantes del dominio
<Links></Links>Enlaces entrantes del dominio
<Age></Age>Antigüedad del dominio
Ejemplo Obtener Subastas Abiertas
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_open_auctions¤cy=usd
Response (XML format)
<GetOpenAuctionsResponse>
<GetOpenAuctionsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetOpenAuctionsHeader>
<GetOpenAuctionsContent>
<Auction>
<AuctionId>0</AuctionId>
<Domain>domain.com</Domain>
<BidPrice>63.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>0</Bids>
<EndTime>2015/04/28 05:46 UTC</EndTime>
<EndTimestamp>1430199960354</EndTimestamp>
<Revenue>72</Revenue>
<RevenueCurrency>USD</RevenueCurrency>
<Visitors>-1</Visitors>
<Links>-1</Links>
<Age>1</Age>
</Auction>
<Auction>
<AuctionId>0</AuctionId>
<Domain>domain.com</Domain>
<BidPrice>63.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>0</Bids>
<EndTime>2015/04/28 05:46 UTC</EndTime>
<EndTimestamp>1430199960354</EndTimestamp>
<Revenue>72</Revenue>
<RevenueCurrency>USD</RevenueCurrency>
<Visitors>-1</Visitors>
<Links>-1</Links>
<Age>1</Age>
</Auction>
.
.
.
</GetOpenAuctionsContent>
</GetOpenAuctionsResponse>
Solicitud (formato csv)
https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions¤cy=usd
Resultado
ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_open_auctions¤cy=usd
Response (JSON format)
{
"status": "success",
"auction_list": [
{
"auction_id": 11,
"domain": "domain.com",
"utf_name": "domain.com",
"is_idn": false,
"auction_type": "expired",
"currency": "USD",
"current_bid_price": "124.00",
"bids": 4,
"bidders": 2,
"time_left": "1 day, 23 hours",
"start_time": "2022/03/28 02:20 PST",
"start_time_stamp": 1648459234033,
"end_time": "2022/04/04 02:20 PST",
"end_time_stamp": 1649064034033,
"visitors": 223,
"links": "-",
"age": 0,
"estibot_appraisal": "-"
},
{
"auction_id": 12,
"domain": "domain0.com",
"utf_name": "domain0.com",
"is_idn": false,
"auction_type": "expired",
"currency": "USD",
"current_bid_price": "44.99",
"bids": 1,
"bidders": 1,
"time_left": "2 days, 23 hours",
"start_time": "2022/03/29 02:20 PST",
"start_time_stamp": 1648545634049,
"end_time": "2022/04/05 02:20 PST",
"end_time_stamp": 1649150434049,
"visitors": 245,
"links": "-",
"age": 0,
"estibot_appraisal": "-"
}
...
]
}
Comando Obtener Detalles de Subasta
Calling the get auction details command will return the details of auction specified. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:
Parámetros de Solicitud Obtener Detalles de SubastaExplicación
Parámetros de Solicitud Obtener Detalles de Subasta
Explicación
domainThe domain name of auction, IDN(International Domain Name) should use punycode, such as "xn--wkccg.com". you can get more than one auctions , each domain must be split by ","
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Etiqueta de respuesta de obtener detalles de subasta, es el nodo raíz del documento de respuesta XML
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Encabezado de detalles de obtener subastas de pedidos en espera
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Etiqueta de contenido de obtener detalles de subasta, sólo se utiliza cuando el estado es "success"
<AuctionStatusId></AuctionStatusId>Status id of auction : '0' for In Progress, '1' for Cancelled by User, '2' for Cancelled by Admin, '3' for Cancelled by Renewal, '4' for Complete, '5' for Cancelled by Transfer Away
<AuctionStatus></AuctionStatus>Estado de subasta
<UserIsHighBid></UserIsHighBid>Si usuario es la oferta más alta
<YourCurrentBid></YourCurrentBid>Su precio comprador actual para la subasta especificada. Si no ha presentado una oferta, será '-1'
<YourProxyBid></YourProxyBid>Su puja máxima para la subasta especificada. Si no ha colocado una oferta, será '-1' <AuctionId></AuctionId>ID de subasta
<Domain></Domain>Nombre de dominio de la subasta
<BidPrice></BidPrice>Precio de compra actual de la subasta
<BidPriceCurrency></BidPriceCurrency>Moneda del precio de compra
<Bids></Bids>Número de ofertas para subasta
<EndTime></EndTime>Hora de finalización de la subasta
<EndTimestamp></EndTimestamp>Fecha de finalización de la subasta en tiempo Unix (milisegundos desde la medianoche UTC de enerO 1, 1970)
<IsPremium></IsPremium>Whether it is a premium domain
<RenewalPrice></RenewalPrice>Renewal price
Ejemplo de Obtener Detalles de Subasta
Request (XML format)
https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com¤cy=usd
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
<GetAuctionDetailsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetAuctionDetailsHeader>
<GetAuctionDetailsContent>
<Auction>
<AuctionStatusId>0</AuctionStatusId>
<AuctionStatus>1</AuctionStatus>
<AuctionId>0</AuctionId>
<Domain>test.biz</Domain>
<BidPrice>46.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>0</Bids>
<EndTime>1970/01/01 00:00 UTC</EndTime>
<EndTimestamp>0</EndTimestamp>
<Revenue>1</Revenue>
<RevenueCurrency>USD</RevenueCurrency>
<Visitors>-1</Visitors>
<Links>1</Links>
<Age>10</Age>
<isPremium>false</isPremium>
<RenewalPrice>-0.1</RenewalPrice>
<UserIsHighBid>false</UserIsHighBid>
<YourCurrentBid>-1</YourCurrentBid>
<YourProxyBid>-1</YourProxyBid>
</Auction>
</GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_auction_details&domain=domain0.com¤cy=usd
Response (JSON format)
{
"status": "success",
"size": 1,
"auction_details": [
{
"auction_json": {
"auction_id": 0,
"domain": "test.biz",
"utf_name": "test.biz",
"is_idn": false,
"auction_type": "expired",
"current_bid_price": "46.99",
"accepted_bid_price": "46.99",
"currency": "USD",
"is_high_bidder": false,
"bids": 0,
"bidders": 0,
"auction_status_id": 0,
"time_left": "1",
"start_time": "1",
"start_time_stamp": 0,
"end_time": "",
"end_time_stamp": 0,
"revenue": "1",
"visitors": -1,
"links": "1",
"age": 10,
"estibot_appraisal": "",
"bidder_name": "",
"bid_price": "",
"timestamp": 0,
"bid_status": "",
"is_proxy_auto_bid": false,
"auction_ended": false,
"customer_bided": false,
"customer_bid": "1",
"customer_proxy_bid": "1",
"is_premium": false,
"renewal_price": "-0.1"
},
"bid_history": []
}
]
}
Comando Colocar Puja en Subasta
Al invocar el comando colocar puja en subasta, se hará una puja (oferta de compra) por la subasta especificada. De invocar a este comando, se deben incluir los siguientes parámetros:
Parámetros de Solicitud Colocar Puja en SubastaExplicación
Parámetros de Solicitud Colocar Puja en Subasta
Explicación
domainEl nombre de dominio de la subasta, IDN (Nombre de Dominio Internacionalizado) debe utilizar codificación punycode, como "xn--wkccg.com"
bid_amountLa cantidad de su puja para la subasta, la moneda por defecto es US Dólares, también puede especificarla según el parámetro de monedas indicado abajo
currency (opcional)La moneda de su puja, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Etiqueta de respuesta de colocar puja en subasta, es el nodo raíz del documento de respuesta XML
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Encabezado de colocar puja en subasta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo de Dominio
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd
Response (XML format)
<PlaceAuctionBidResponse>
<PlaceAuctionBidHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
Solicitud (formato csv)
https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd
Resultado
ok,success
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd
Response (JSON format)
{
"status": "success",
"auction_details": {
"auction_json": {
"auction_id": 12,
"domain": "example.com",
"utf_name": "example.com",
"is_idn": false,
"auction_type": "expired",
"current_bid_price": "44.99",
"accepted_bid_price": "45.99",
"currency": "USD",
"is_high_bidder": true,
"bids": 3,
"bidders": 2,
"time_left": "2 days, 22 hours",
"start_time": "2022/03/29 02:20 PST",
"start_time_stamp": 1648545634049,
"end_time": "2022/04/05 02:20 PST",
"end_time_stamp": 1649150434049,
"revenue": "$26.50",
"visitors": 245,
"links": "-",
"age": 0,
"estibot_appraisal": "-",
"auction_ended": false,
"customer_bided": true,
"customer_bid": "44.99",
"customer_proxy_bid": "$121.00"
},
"bid_history": [
{
"bidder_name": "You",
"bid_price": "44.99",
"currency": "USD",
"timestamp": 1648892255084,
"bid_status": "High Bidder",
"is_proxy_auto_bid": false
}
... ]
}
}
Comando Obtener Subastas Cerradas
Al invocar el comando “obtener subastas cerradas”, le devolverá una lista de subastas cerradas de la cuenta especificada. Si invoca este comando, deben incluirse los siguientes parámetros:
Parámetros de Solicitud Obtener Subastas CerradasExplicación
Parámetros de Solicitud Obtener Subastas Cerradas
Explicación
startDateFecha de inicio de subasta, aaaa-mm-dd, ejemplo 2015-05-05
endDateFecha de finalización de subasta, aaaa-mm-dd, ejemplo 2015-05-05
currency (opcional)La moneda de su puja, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Etiqueta de respuesta obtener subastas cerradas, es el nodo raíz del documento de respuesta XML
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Encabezado de obtener subastas cerradas
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Etiqueta de contenido de obtener subastas cerradas, sólo se utiliza cuando el estado es "success"
<Auction></Auction>Etiqueta de ítem de subasta, sólo se utiliza cuando el estado es "success"
<AuctionId></AuctionId>ID de subasta
<Domain></Domain>Nombre de dominio de la subasta
<AuctionStatusId></AuctionStatusId>ID de estado de subasta, '0' para las En curso y '1' para las Cerradas por el Usuario, '2' para Cerradas por Admin, '3' para Cerradas por Renovación, '4' para Cerradas por Tiempo de espera, '5' para Cerrado por Transferencia
<AuctionStatus></AuctionStatus>Estado de subasta
<BidPrice></BidPrice>Precio de compra actual de la subasta
<BidPriceCurrency></BidPriceCurrency>Moneda del precio de compra
<Bids></Bids>Número de ofertas para subasta
<AuctionWonStatus></AuctionWonStatus>Si el usuario ganó esta subasta
<YourHighBid></YourHighBid>Su puja más alta para esta subasta
<YourProxyBid></YourProxyBid>Su puja máxima para esta subasta
Ejemplo Obtener Subastas Cerradas
Request (XML format)
https://api.dynadot.com/api3.xml?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
<GetClosedAuctionsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetClosedAuctionsHeader>
<GetClosedAuctionsContent>
<Auction>
<AuctionId>2</AuctionId>
<Domain>testdomain1.test</Domain>
<AuctionStatusId>4</AuctionStatusId>
<AuctionStatus>Closed by Timeout</AuctionStatus>
<BidPrice>89.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>1</Bids>
<AuctionWonStatus>won</AuctionWonStatus>
<YourHighBid>89.99</YourHighBid>
<YourProxyBid>1000.0</YourProxyBid>
</Auction>
<Auction>
<AuctionId>3</AuctionId>
<Domain>testdomain2.test</Domain>
<AuctionStatusId>4</AuctionStatusId>
<AuctionStatus>Closed by Timeout</AuctionStatus>
<BidPrice>28.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>1</Bids>
<AuctionWonStatus>won</AuctionWonStatus>
<YourHighBid>28.99</YourHighBid>
<YourProxyBid>1000.0</YourProxyBid>
</Auction>
</GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Request (CSV format)
https://api.dynadot.com/api3.html?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (CSV format)
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
Request (JSON format)
https://api.dynadot.com/api3.json?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (JSON format)
{
"GetClosedAuctionsResponse": {
"ResponseCode": 0,
"Status": "success",
"Auctions": [
{
"AuctionId": "2",
"Domain": "testdomain1.test",
"AuctionStatusId": "4",
"AuctionStatus": "Closed by Timeout",
"BidPrice": "89.99",
"BidPriceCurrency": "USD",
"Bids": "1",
"AuctionWonStatus": "won",
"YourHighBid": "89.99",
"YourProxyBid": "1000.0"
},
{
"AuctionId": "3",
"Domain": "testdomain2.test",
"AuctionStatusId": "4",
"AuctionStatus": "Closed by Timeout",
"BidPrice": "28.99",
"BidPriceCurrency": "USD",
"Bids": "1",
"AuctionWonStatus": "won",
"YourHighBid": "28.99",
"YourProxyBid": "1000.0"
}
]
}
}
Comando Obtener Subastas de Pedidos en Espera Abiertas(Deprecated,please use get_open_auctions command)
Llamar al comando de obtener subastas de pedidos en espera abiertas devolverá una lista de subastas de pedidos en espera que están en curso. Si se llama a este comando, se deben incluir los siguientes parámetros:
Obtener el Parámetro de Solicitud de Subastas de Pedidos en EsperaExplicación
Obtener el Parámetro de Solicitud de Subastas de Pedidos en Espera
Explicación
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Etiqueta de obtener respuesta de subastas de pedidos en espera, es el nodo raíz del documento de respuesta XML
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Obtener el encabezado de las subastas de pedidos en espera pendientes
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Etiqueta de obtener contenido de subastas de pedidos en espera abiertas, solo se usa cuando el estado es "success"
<Auction></Auction>Etiqueta de ítem de subasta, sólo se utiliza cuando el estado es "success"
<AuctionId></AuctionId>ID de subasta
<Domain></Domain>Nombre de dominio de la subasta
<BidPrice></BidPrice>Precio de compra actual de la subasta
<BidPriceCurrency></BidPriceCurrency>Moneda del precio de compra
<Bids></Bids>Número de ofertas para subasta
<EndTime></EndTime>Hora de finalización de la subasta
<EndTimestamp></EndTimestamp>Fecha de finalización de la subasta en tiempo Unix (milisegundos desde la medianoche UTC de enerO 1, 1970)
Ejemplo de Obtener Subastas de Pedidos en Espera Abiertas
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_open_backorder_auctions¤cy=usd
Response (XML format)
<GetOpenBackorderAuctionsResponse>
<GetOpenBackorderAuctionsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetOpenBackorderAuctionsHeader>
<GetOpenBackorderAuctionsContent>
<Auction>
<AuctionId>0</AuctionId>
<Domain>domain.com</Domain>
<BidPrice>63.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>0</Bids>
<EndTime>2015/04/28 05:46 UTC</EndTime>
<EndTimestamp>1430199960354</EndTimestamp>
</Auction>
<Auction>
<AuctionId>0</AuctionId>
<Domain>domain.com</Domain>
<BidPrice>63.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>0</Bids>
<EndTime>2015/04/28 05:46 UTC</EndTime>
<EndTimestamp>1430199960354</EndTimestamp>
</Auction>
.
.
.
</GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>
Solicitud (formato csv)
https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions¤cy=usd
Resultado
ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.
Comando Obtener Detalles de Subastas de Pedidos en Espera
Calling the get backorder auction details command will return the details of auction specified. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:
Parámetros de Solicitud Obtener Detalles de SubastaExplicación
Parámetros de Solicitud Obtener Detalles de Subasta
Explicación
domainEl nombre de dominio de subasta de pedidos en espera, IDN (Nombre de Dominio Internacionalizado) debe usar punycode, como "xn--wkccg.com"
currency (opcional)La moneda del resultado que se retorna, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Etiqueta de respuesta de obtener detalles de subasta, es el nodo raíz del documento de respuesta XML
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Encabezado de obtener detalles de subasta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Etiqueta de contenido de obtener detalles de subasta, sólo se utiliza cuando el estado es "success"
<AuctionStatusId></AuctionStatusId>ID de estado de subasta, '0' para las En curso y '1' para las Cerradas por el Usuario, '2' para Cerradas por Admin, '3' para Cerradas por Renovación, '4' para Cerradas por Tiempo de espera, '5' para Cerrado por Transferencia
<AuctionStatus></AuctionStatus>Estado de subasta
<AuctionId></AuctionId>ID de subasta
<Domain></Domain>Nombre de dominio de la subasta
<BidPrice></BidPrice>Precio de compra actual de la subasta
<BidPriceCurrency></BidPriceCurrency>Moneda del precio de compra
<Bids></Bids>Número de ofertas para subasta
<EndTime></EndTime>Hora de finalización de la subasta
<EndTimestamp></EndTimestamp>Fecha de finalización de la subasta en tiempo Unix (milisegundos desde la medianoche UTC de enerO 1, 1970)
<Revenue></Revenue>Ingresos de la subasta
<RevenueCurrency></RevenueCurrency>Moneda de los ingresos
<Visitors></Visitors>Visitantes del dominio
<Links></Links>Enlaces entrantes del dominio
<Age></Age>Antigüedad del dominio
<UserIsHighBid></UserIsHighBid>Si usuario es la oferta más alta
<YourCurrentBid></YourCurrentBid>Su precio comprador actual para la subasta especificada. Si no ha presentado una oferta, será '-1'
<YourProxyBid></YourProxyBid>Su puja máxima para la subasta especificada. Si no ha colocado una oferta, será '-1' Ejemplo de Detalles de Obtener Subastas de Pedidos en Espera
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_backorder_auction_details&domain=example.com¤cy=usd
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
<GetBackorderAuctionDetailsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetBackorderAuctionDetailsHeader>
<GetBackorderAuctionDetailsContent>
<AuctionStatusId>0</AuctionStatusId>
<AuctionStatus>In Progress</AuctionStatus>
<UserIsHighBid>no</UserIsHighBid>
<YourCurrentBid>-1</YourCurrentBid>
<YourProxyBid>-1</YourProxyBid>
<Auction>
<AuctionId>10001</AuctionId>
<Domain>example.com</Domain>
<BidPrice>89.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>0</Bids>
<EndTime>2015/04/28 18:16 UTC</EndTime>
<EndTimestamp>1430244969779</EndTimestamp>
</Auction>
</GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_backorder_auction_details&domain=example.com¤cy=usd
Response (JSON format)
{
"GetBackorderAuctionDetailsResponse": {
"ResponseCode": 0,
"Status": "success",
"GetBackorderAuctionDetails": {
"AuctionStatusId": "0",
"AuctionStatus": "In Progress",
"UserIsHighBid": "no",
"YourCurrentBid": "-1",
"YourProxyBid": "-1",
"Auction": {
"AuctionId": "10001",
"Domain": "example.com",
"BidPrice": "89.99",
"BidPriceCurrency": "USD",
"Bids": "0",
"EndTime": "2015/04/28 18:16 UTC",
"EndTimestamp": "1430244969779"
}
}
}
}
Colocar Comando de Puja de Subastas de Pedidos en Espera
Llamar al comando colocar puja en subasta de pedidos en espera colocará una puja para la subasta especificada de pedidos en espera. Si llama este comando, se deben incluir los siguientes parámetros:
Colocar Parámetro de Solicitud de Puja para Subasta de Pedidos en EsperaExplicación
Colocar Parámetro de Solicitud de Puja para Subasta de Pedidos en Espera
Explicación
domainEl nombre de dominio de la subasta, IDN (Nombre de Dominio Internacionalizado) debe utilizar codificación punycode, como "xn--wkccg.com"
bid_amountLa cantidad de su puja para la subasta, la moneda por defecto es US Dólares, también puede especificarla según el parámetro de monedas indicado abajo
currency (opcional)La moneda de su puja, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Etiqueta de respuesta de colocar puja en subasta, es el nodo raíz del documento de respuesta XML
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Encabezado de colocar puja en subasta
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
Ejemplo Colocar Puja en Subasta de Pedidos en Espera
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd
Response (XML format)
<PlaceBakcorderAuctionBidResponse>
<PlaceBackorderAuctionBidHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Request (CSV format)
https://api.dynadot.com/api3.html?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd
Response (CSV format)
ok,success
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9¤cy=usd
Response (JSON format)
{
"PlaceBakcorderAuctionBidResponse":{
"ResponseCode":"0",
"Status":"success"
}
}
Obtener Comando de Subastas de Pedidos en Espera Cerradas
Llamar al comando obtener subastas de pedidos en espera cerradas devolverá una lista de subastas de pedidos en espera cerradas de una cuenta especificada. Si llama a este comando, se deben incluir los siguientes parámetros:
Parámetro de Solicitud Obtener Subastas de Pedidos en Espera CerradasExplicación
Parámetro de Solicitud Obtener Subastas de Pedidos en Espera Cerradas
Explicación
startDateFecha de inicio de subasta, aaaa-mm-dd, ejemplo 2015-05-05
endDateFecha de finalización de subasta, aaaa-mm-dd, ejemplo 2015-05-05
currency (opcional)La moneda de su puja, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Etiqueta de respuesta obtener subastas cerradas, es el nodo raíz del documento de respuesta XML
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Encabezado de obtener subastas cerradas
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Etiqueta de contenido de obtener subastas cerradas, sólo se utiliza cuando el estado es "success"
<Auction></Auction>Etiqueta de ítem de subasta, sólo se utiliza cuando el estado es "success"
<YourHighBid></YourHighBid>Su puja más alta para esta subasta
<YourProxyBid></YourProxyBid>Su puja máxima para esta subasta
<AuctionId></AuctionId>ID de subasta
<Domain></Domain>Nombre de dominio de la subasta
<AuctionStatusId></AuctionStatusId>ID de estado de subasta, '0' para las En curso y '1' para las Cerradas por el Usuario, '2' para Cerradas por Admin, '3' para Cerradas por Renovación, '4' para Cerradas por Tiempo de espera, '5' para Cerrado por Transferencia
<AuctionStatus></AuctionStatus>Estado de subasta
<BidPrice></BidPrice>Precio de compra actual de la subasta
<BidPriceCurrency></BidPriceCurrency>Moneda del precio de compra
<Bids></Bids>Número de ofertas para subasta
Get Closed Backorder Auctions Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
<GetClosedBackorderAuctionsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetClosedBackorderAuctionsHeader>
<GetClosedBackorderAuctionsContent>
<Auction>
<AuctionWonStatus>won</AuctionWonStatus>
<YourHighBid>89.99</YourHighBid>
<YourProxyBid>1000.0</YourProxyBid>
<AuctionId>2</AuctionId>
<Domain>testdomain1.test</Domain>
<BidPrice>89.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>1</Bids>
<EndTime>2022/04/04 02:20:34 PST</EndTime>
<EndTimestamp>1649064034033</EndTimestamp>
</Auction>
<Auction>
<AuctionWonStatus>won</AuctionWonStatus>
<YourHighBid>28.99</YourHighBid>
<YourProxyBid>1000.0</YourProxyBid>
<AuctionId>3</AuctionId>
<Domain>testdomain2.test</Domain>
<BidPrice>28.99</BidPrice>
<BidPriceCurrency>USD</BidPriceCurrency>
<Bids>1</Bids>
<EndTime>2022/04/05 02:20:34 PST</EndTime>
<EndTimestamp>1649150434049</EndTimestamp>
</Auction>
</GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>
Request (CSV format)
https://api.dynadot.com/api3.html?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (CSV format)
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
Request (JSON format)
https://api.dynadot.com/api3.json?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15
Response (JSON format)
{
"GetClosedBackorderAuctionsResponse": {
"ResponseCode": 0,
"Status": "success",
"Auctions": [
{
"AuctionWonStatus": "won",
"YourHighBid": "89.99",
"YourProxyBid": "1000.0",
"AuctionId": "2",
"Domain": "testdomain1.test",
"BidPrice": "89.99",
"BidPriceCurrency": "USD",
"Bids": "1",
"EndTime": "2022/04/04 02:20:34 PST",
"EndTimestamp": "1649064034033"
},
{
"AuctionWonStatus": "won",
"YourHighBid": "28.99",
"YourProxyBid": "1000.0",
"AuctionId": "3",
"Domain": "testdomain2.test",
"BidPrice": "28.99",
"BidPriceCurrency": "USD",
"Bids": "1",
"EndTime": "2022/04/05 02:20:34 PST",
"EndTimestamp": "1649150434049"
}
]
}
}
Comando Obtener Pujas de Subasta
Calling the get auction bids command will get your bids list which you took part in. If calling this command, the following parameters should be included:
Get Auction Bids Request ParameterExplicación
Get Auction Bids Request Parameter
Explicación
currency (opcional)La moneda de su puja, debe ser "usd", "eur", o "cny",, la moneda por defecto es el dólar estadounidense
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetAuctionBidsResponse></GetAuctionBidsResponse>Tag of get auction bids response, it's the root node of the response XML document
<GetAuctionBidsHeader></GetAuctionBidsHeader>Get auction bids header
<SuccessCode></SuccessCode>Si la operación tiene éxito, "0" para correcto, "-1" para falla.
<Status></Status>El estatus de la solicitud
<Error></Error>Información de error acerca de la solicitud, sólo se utiliza cuando el estatus es "error"
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> Bid List
<Bid></Bid> Bid Item
<BidId></BidId> ID of bid
<AuctionId></AuctionId> ID of auction
<AccountId></AccountId>ID of account
<Domain></Domain>Nombre de dominio de la subasta
<DomainUtf></DomainUtf>Domain utf name of auction
<AuctionType></AuctionType>Type of auction
<IsIdn></IsIdn>If this domain is Internationalized Domain Name
<CurrentBid></CurrentBid>Current bid price for the auction
<YourStatus></YourStatus>Your bid status for the auction
<ProxyBid></ProxyBid>Your proxy bid price for the auction
<ActiveBidders></ActiveBidders>The amount of bidders who take part in this auction
<TimeLeft></TimeLeft>the left time for the auction
<EndTime></EndTime>The end time for the auction
<EndTimestamp></EndTimestamp>The end time stamp for the auction
Ejemplo de Obtener Pujas de Subasta
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=get_auction_bids&currency=usd
Response (XML format)
<GetAuctionBidsResponse>
<GetAuctionBidsHeader>
<SuccessCode>0</SuccessCode>
<Status>success</Status>
</GetAuctionBidsHeader>
<GetAuctionBidsContent>
<BidList>
<Bid>
<BidId>0</BidId>
<AuctionId>11</AuctionId>
<AccountId>1</AccountId>
<Domain>domain.com</Domain>
<DomainUtf>domain.com</DomainUtf>
<AuctionType>expired</AuctionType>
<IsIdn>false</IsIdn>
<CurrentBid>$124.00</CurrentBid>
<YourStatus>Out Bid</YourStatus>
<ProxyBid>$119.00</ProxyBid>
<ActiveBidders>2</ActiveBidders>
<TimeLeft>1 day, 6 hours</TimeLeft>
<EndTime>2022/04/04 02:20:34 PST</EndTime>
<EndTimestamp>1649064034033</EndTimestamp>
</Bid>
<Bid>
<BidId>9</BidId>
<AuctionId>12</AuctionId>
<AccountId>1</AccountId>
<Domain>domain0.com</Domain>
<DomainUtf>domain0.com</DomainUtf>
<AuctionType>expired</AuctionType>
<IsIdn>false</IsIdn>
<CurrentBid>$44.99</CurrentBid>
<YourStatus>High Bidder</YourStatus>
<ProxyBid>$121.00</ProxyBid>
<ActiveBidders>1</ActiveBidders>
<TimeLeft>2 days, 6 hours</TimeLeft>
<EndTime>2022/04/05 02:20:34 PST</EndTime>
<EndTimestamp>1649150434049</EndTimestamp>
</Bid>
</BidList>
</GetAuctionBidsContent>
</GetAuctionBidsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=mykey&command=get_auction_bids&currency=usd
Response (JSON format)
{
"status": "success",
"auction_bids": [
{
"bid_id": 0,
"auction_id": 11,
"account_id": "1",
"domain": "domain.com",
"domain_utf": "domain.com",
"auction_type": "expired",
"is_idn": false,
"current_bid": "$44.99",
"your_status": "High Bidder",
"proxy_bid": "$119.00",
"active_bidders": 1,
"time_left": "1 day, 23 hours",
"end_time": "2022/04/04 02:20:34 PST",
"end_time_stamp": 1649064034033
},
{
"bid_id": 2,
"auction_id": 12,
"account_id": "1",
"domain": "domain0.com",
"domain_utf": "domain0.com",
"auction_type": "expired",
"is_idn": false,
"current_bid": "$44.99",
"your_status": "High Bidder",
"proxy_bid": "$119.00",
"active_bidders": 1,
"time_left": "2 days, 23 hours",
"end_time": "2022/04/05 02:20:34 PST",
"end_time_stamp": 1649150434049
}
...
]
}
Comando Está Procesando
Invocar el comando is_processing (está procesando) le indicará si es seguro enviar una nueva solicitud
Parámetro Solicitud Is-ProcessingExplicación
Parámetro Solicitud Is-Processing
Explicación
no se necesita ningún parámetro extra
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<Response></Response>Etiqueta de respuesta de comando is_processing (está procesando)
<RespnseHeader></RespnseHeader>Etiqueta de encabezado de comando is_processing (está procesando)
<ResponseMsg></ResponseMsg>Etiqueta de mensaje de respuesta is_processing (está procesando). Debe ser "sí" (Hay un proceso en el sistema. No se debe enviar una nueva solicitud) o "no" (No hay ningún proceso en su cuenta. Es seguro enviar una nueva solicitud.)
Ejemplo Is-Processing
Request (XML format)
https://api.dynadot.com/api3.xml?key=mykey&command=is_processing
Response (XML format)
<Response>
<ResponseHeader>
<ResponseCode>0</ResponseCode>
<ResponseMsg>yes</ResponseMsg>
</ResponseHeader>
</Response>
Request (CSV format)
http://api.dynadot.com/api3.html?key=mykey&command=is_processing
Response (CSV format)
ok,yes
Request (JSON format)
http://api.dynadot.com/api3.html?key=mykey&command=is_processing
Response (JSON format)
{
"Response":{
"ResponseCode":"0",
"ResponseMsg":"no"
}
}
Get Expired Closeout Domains Command
Calling the Get Expired Closeout Domains Command will Get Expired Closeout Domains. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:
Get Expired Closeout Domains Request ParameterExplicación
Get Expired Closeout Domains Request Parameter
Explicación
currency(optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
domain(optional)Add this parameter if you want to query for a closeout domain
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Tag of Get Expired Closeout Domains response, it's the root node of the response XML document
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Get Expired Closeout Domains Header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>El estatus de la solicitud
<Error></Error>Error information about the request, only used when status is "error"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>CloseoutItem
<DomainName></DomainName>The domain name
<DomainNameUtf></DomainNameUtf>The domain name is in utf format
<CurrentPrice></CurrentPrice>current price
<isIdn></isIdn>Whether it is the idn domain name
<EndTimeStamp></EndTimeStamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)
<RenewalPrice></RenewalPrice>Renewal price
<ExpiredRevenue></ExpiredRevenue>Revenue of closeout
<EstibotAppraisal></EstibotAppraisal>EstibotAppraisal
<InboundLinks></InboundLinks>Enlaces entrantes del dominio
<MonthlyVisitors></MonthlyVisitors>Visitantes del dominio
<Currency></Currency>currency
Get Expired Closeout Domains Example
Request (XML format)
https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=usd
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
<GetExpiredCloseoutDomainsHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</GetExpiredCloseoutDomainsHeader>
<GetExpiredCloseoutDomainsContent>
<CloseoutItem>
<DomainName>test.biz</DomainName>
<DomainNameUtf>test.biz</DomainNameUtf>
<CurrentPrice>9.91</CurrentPrice>
<IsIDN>false</IsIDN>
<EndTimeStamp>0</EndTimeStamp>
<RenewalPrice>9.99</RenewalPrice>
<ExpiredRevenue>9.90</ExpiredRevenue>
<EstibotAppraisal>1223</EstibotAppraisal>
<InboundLinks>-1</InboundLinks>
<MonthlyVisitors>-1</MonthlyVisitors>
<Currency>usd</Currency>
</CloseoutItem>
</GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>
Request (JSON format)
https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=usd
Response (JSON format)
{
"GetExpiredCloseoutDomainsResponse": {
"ResponseCode": 0,
"Status": "success",
"Size": 1,
"CloseoutDomains": [
{
"closeoutItem": {
"domainName": "test.biz",
"domainNameUtf": "test.biz",
"currentPrice": "9.91",
"isIdn": false,
"endTimeStamp": 0,
"renewalPrice": "9.99",
"expiredRevenue": "9.90",
"estibotAppraisal": "1223",
"inboundLinks": -1,
"monthlyVisitors": -1,
"currency": "usd"
}
}
]
}
}
Buy Expired Closeout Domain Command
Calling the Buy Expired Closeout Domain Command will buy the specified domain name. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:
Buy Expired Closeout Domain Request ParameterExplicación
Buy Expired Closeout Domain Request Parameter
Explicación
domainThe domain you want to buy, only 1 domain can be entered per request
currency(optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Tag of Buy Expired Closeout Domain response, it's the root node of the response XML document
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Buy Expired Closeout Domain header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>El estatus de la solicitud
<Error></Error>Error information about the request, only used when status is "error"
Buy Expired Closeout Domain Example
Request (XML format)
http://127.0.0.1:8889/api3.xml?key=0&command=buy_expired_closeout_domain¤cy=USD&domain=domain-exp141.org.ph
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
<BuyExpiredCloseoutDomainHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Request (JSON format)
http://127.0.0.1:8889/api3.json?key=0&command=buy_expired_closeout_domain¤cy=USD&domain=domain-exp141.org.ph
Response (JSON format)
{
"BuyExpiredCloseoutDomainResponse": {
"ResponseCode": "0",
"Status": "success"
}
}
Get Order Status Command
Calling the Get Order Status Command will get order status. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:
Get Order Status Request ParameterExplicación
Get Order Status Request Parameter
Explicación
order_idThe id of the order to be queried
Etiqueta XML resultadoExplicación
Etiqueta XML resultado
Explicación
<GetOrderStatusResponse></GetOrderStatusResponse>the root node of the response
<GetOrderStatusHeader></GetOrderStatusHeader>Get Order Status header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>El estatus de la solicitud
<Error></Error>Error information about the request, only used when status is "error"
<GetOrderStatusContent></GetOrderStatusContent>response content
<OrderId></OrderId>order id
<OrderStatus></OrderStatus>order status( Shopping, Submitted,
Waitpay, Processing, Completed, Problem, Deleted, Cancelled )
<ItemTypeName></ItemTypeName>item Type
<ItemName></ItemName>item Name
<ItemStatus></ItemStatus>Item Status(Completed, Cancelled, Problem)
Get Order Status Example
Request (XML format)
http://127.0.0.1:8889/api3.xml?key=0&command=get_ordedr_status&order_id=0
Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
<GetOrderStatusHeader>
<ResponseCode>0</ResponseCode>
<Status>success</Status>
</GetOrderStatusHeader>
<GetOrderStatusContent>
<OrderId>0</OrderId>
<OrderStatus>Completed</OrderStatus>
<Item>
<ItemTypeName>domain transfer away</ItemTypeName>
<ItemName>&</ItemName>
<ItemStatus>transfer.com</ItemStatus>
</Item>
<Item>
<ItemTypeName>domain</ItemTypeName>
<ItemName>&</ItemName>
<ItemStatus>register.com</ItemStatus>
</Item>
</GetOrderStatusContent>
</GetOrderStatusResponse>
Request (JSON format)
http://127.0.0.1:8889/api3.json?key=0&command=get_ordedr_status&order_id=0
Response (JSON format)
{
"GetOrderStatusResponse": {
"ResponseCode": 0,
"Status": "success",
"OrderStatus": {
"OrderId": 0,
"OrderStatus": "Completed",
"ItemList": [
{
"ItemTypeName": "domain transfer away",
"ItemName": "transfer.com",
"ItemStatus": "Completed"
},
{
"ItemTypeName": "domain",
"ItemName": "register.com",
"ItemStatus": "Completed"
}
]
}
}
}