Acciones de API

RegisterDomain:

Este es un comando para enviar una petición / comando de registro al proveedor.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
regperiod Number Si Registration period
nameserver1 String No First nameserver
nameserver2 String No Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver
dnsmanagement Number No Enables dns management for this domain
emailforwarding Number No Enables email forwarding for this domain
idprotection Number No Enables id protection for this domain
firstname String Si First name of the user
lastname String Si Last name of the user
address1 String Si First part of user address
address2 String No Second part of user address
city String Si City of the user
state String Si State/Province of the user
postcode String Si Postal/ZIP Code of the user
country String Si Country of the user
phonenumber String Si Phone number in the format +NNN.NNNNNNNNNN
email String Si Email address of the user
adminfirstname String No First name of the admin user
adminlastname String No Last name of the admin user
adminaddress1 String No First part of admin user address
adminaddress2 String No Second part of admin user address
admincity String No City of the admin user
adminstate String No State/Province of the admin user
adminpostcode String No Postal/ZIP Code of the admin user
admincountry String No Country of the admin user
adminphonenumber String No Phone number in the format +NNN.NNNNNNNNNN
adminemail String No Email address of the admin user
domainfields String No A base64 encoded serialized array of the TLD specific field values

Ejemplo de Solicitud:

Ejemplo de Respuesta:

RenewDomain

Este es un comando para enviar una petición / comando de Renovación al proveedor.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
regperiod Number Si Registration period

Ejemplo de Solicitud:

Ejemplo de Respuesta:

GetNameservers

Este comando se utiliza para obtener los servidores de nombres de un dominio.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
regperiod Number Si Registration period

Ejemplo de Solicitud:

Ejemplo de Respuesta:

GetNameservers

Este comando se utiliza para obtener los servidores de nombres de un dominio.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

SaveNameservers

Este comando se utiliza para actualizar los servidores de nombres de un dominio.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
nameserver1 String No First nameserver
nameserver2 String No Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver

Ejemplo de Solicitud:

Ejemplo de Respuesta:

ReleaseDomain

Este comando se utiliza para enviar un comando de lanzamiento para el registrador.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
newtag String Si The new tag for the domain

Ejemplo de Solicitud:

Ejemplo de Respuesta:

RequestDelete

Se invoca esta función cuando se solicita un dominio que desea eliminar

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta

GetEPPCode

Este comando se utiliza para obtener el código EPP / Auth de un dominio.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

GetContactDetails

Este comando se utiliza para realizar una búsqueda whois en un dominio especificado.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

SaveContactDetails

Este comando se utiliza para actualizar la información de contacto en un dominio.

Parámetros de Petición

Name Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
contactdetails Array Si

Ejemplo de Solicitud:

Ejemplo de Respuesta:

DomainGetLockingStatus

Este comando se utiliza para obtener el estado de bloqueo de un dominio.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

DomainUpdateLockingStatus

Este comando se utiliza para actualizar el estado de bloqueo de un dominio.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
lockstatus Null/Number No To lock the domain, set it to ‘1’

Ejemplo de Solicitud:

Ejemplo de Respuesta:

GetDNS

Se invoca esta función cuando se solicitan los registros de host DNS para ser visto en WHMCS

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

SaveDNS

Se invoca esta función cuando se presente algún cambio en los Regisotrs de DNS.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
dnsrecords String Si A base64 encoded serialized array of the dns records.
base64_encode(serialize(array(0=>array(“hostname”=>”*”,”type”=>”A”,”address”=>”0.0.0.0″,”priority”=>”N/A”,”recid”=>””))));;

Ejemplo de Solicitud:

Ejemplo de Respuesta:

RegisterNameserver

Se invoca esta función cuando se solicita un servidor de nombres niño a ser inscrito.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
nameserver String Si
ipaddress String Si

Ejemplo de Solicitud:

Ejemplo de Respuesta:

ModifyNameserver

Se invoca esta función cuando se solicita un servidor de nombres que se va a editar

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
nameserver String Si
currentipaddress String Si
newipaddress String Si

Ejemplo de Solicitud:

Ejemplo de Respuesta:

DeleteNameserver

Se invoca esta función cuando se solicita un servidor de nombres que desea borrar

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
nameserver String Si

Ejemplo de Solicitud:

Ejemplo de Respuesta:

GetEmailForwarding

Esta función se llama cuando se pidió al reenvío de correo electrónico para ser visto dentro de WHMCS

Parámetros de Petición

Name Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

SaveEmailForwarding

Esta función se llama cuando se pidió al reenvío de correo electrónico para ser visto dentro de WHMCS

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
prefix String Si A base64 encoded serialized array of the prefixes.
base64_encode(serialize(array(0=>”test”))));
forwardto String Si A base64 encoded serialized array of the forwards.
base64_encode(serialize(array(0=>”test@exampledomain.com”)));

Ejemplo de Solicitud:

Ejemplo de Respuesta:

Sync

Esta función puede incluir cambios en la sincronización de estado, renovaciones, y fechas de caducidad.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name

Ejemplo de Solicitud:

Ejemplo de Respuesta:

TransferSync

Se invoca esta función para cada dominio en el estado de la transferencia pendiente cada vez que su sincronización cron dominio se ejecuta.

Parámetros de Petición

Nombre Tipo ¿Requerido? Descripción
sld String Si Domain name
tld String Si Suffix attached to domain name
domain String Si Full domain name
regperiod Int Si Registration period

Ejemplo de Solicitud:

Ejemplo de Respuesta:

 

 

¿Te resultó útil este artículo?

Artículos relacionados