UA-51298262-10
DominiosReseller de Dominios

Acciones de API

By abril 26, 2018agosto 5th, 2020No Comments

¿Conoces algunas acciones de API? En este artículo de Ayuda Hosting, les mostraremos algunos de los más empleados comandos o acciones de API (Application Programming Interface) o Interfaz de programación de aplicaciones.

También le puedes echar un vistazo a nuestra guía de introducción a la API / Módulo.

Acciones de API

¿Qué es una API? (Interfaz de programación de aplicaciones)

API es el acrónimo de Application Programming Interface. Este es un software intermediario que permite que dos aplicaciones se comuniquen entre sí.

Adicionalmente, este software reúne un conjunto de herramientas, protocolos o rutinas empleadas para crear aplicaciones. Una API le informa a determinado software cómo debe interactuar. Por ejemplo, cada vez que empleamos una aplicación como Facebook en nuestro teléfono móvil, este envía un mensaje instantáneo o verifica el estado del clima de manera simultánea. Es así como al hacer esto, se está empleando una API.

Acciones de API

Acciones de API

Veamos a continuación, algunos de los comandos o acciones de API más empleadas y sus funciones.

RegisterDomain

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
regperiodNumberSiRegistration period
nameserver1StringNoFirst nameserver
nameserver2StringNoSecond nameserver
nameserver3StringNoThird nameserver
nameserver4StringNoFourth nameserver
nameserver5StringNoFifth nameserver
dnsmanagementNumberNoEnables dns management for this domain
emailforwardingNumberNoEnables email forwarding for this domain
idprotectionNumberNoEnables id protection for this domain
firstnameStringSiFirst name of the user
lastnameStringSiLast name of the user
address1StringSiFirst part of user address
address2StringNoSecond part of user address
cityStringSiCity of the user
stateStringSiState/Province of the user
postcodeStringSiPostal/ZIP Code of the user
countryStringSiCountry of the user
phonenumberStringSiPhone number in the format +NNN.NNNNNNNNNN
emailStringSiEmail address of the user
adminfirstnameStringNoFirst name of the admin user
adminlastnameStringNoLast name of the admin user
adminaddress1StringNoFirst part of admin user address
adminaddress2StringNoSecond part of admin user address
admincityStringNoCity of the admin user
adminstateStringNoState/Province of the admin user
adminpostcodeStringNoPostal/ZIP Code of the admin user
admincountryStringNoCountry of the admin user
adminphonenumberStringNoPhone number in the format +NNN.NNNNNNNNNN
adminemailStringNoEmail address of the admin user
domainfieldsStringNoA base64 encoded serialized array of the TLD specific field values

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RegisterDomain&sld=exampledomain&tld=com&regperiod=1&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&firstname=test&lastname=test&companyname=company&address1=addresss&city=city&state=region&country=US&postcode=12345&phonenumber=1234567890&[email protected]' --compresse

Ejemplo de Respuesta:

{"result":"success","msg":"Domain has been registered"}

RenewDomain

Este es un comando para enviar una petición o comando de renovación a un proveedor de hosting.

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
regperiodNumberSiRegistration period

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RenewDomain&sld=exampledomain&tld=com&regperiod=1' --compressed

Ejemplo de Respuesta:

{"result":"success","msg":"The domain has been successfully."}

GetNameservers

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
regperiodNumberSiRegistration period

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RenewDomain&sld=exampledomain&tld=com&regperiod=1' --compressed

Ejemplo de Respuesta:

{"result":"success","msg":"The domain has been successfully."}

GetNameservers

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetNameservers&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta:

{"result":"success","ns1":"ns1.exampledomain.com","ns2":"ns2.exampledomain.com"}

SaveNameservers

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
nameserver1StringNoFirst nameserver
nameserver2StringNoSecond nameserver
nameserver3StringNoThird nameserver
nameserver4StringNoFourth nameserver
nameserver5StringNoFifth nameserver

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveNameservers&sld=exampledomain&tld=com&ns1=ns1.exampledomain.com&ns2=ns2.exampledomain.com' --compressed

Ejemplo de Respuesta:

{"result":"success"}

ReleaseDomain

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
newtagStringSiThe new tag for the domain

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=ReleaseDomain&sld=exampledomain&tld=com&newtag=1AND1-TEST' --compressed

Ejemplo de Respuesta:

{"result":"success"}

RequestDelete

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RequestDelete&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta

{"result":"success"}

GetEPPCode

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetEPPCode&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta:

{"result":"success","eppcode":"23svxce123fds"}

GetContactDetails

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetContactDetails&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta:

{"result":"success","Registrant":{"Name":"John Doe","Company":"Company name","Address":"P.O.","City":"Amsterdam","Country":"NL","Zip_Code":"1001 GT","Email":"[email protected]","Telephone":"N\/A"}}

SaveContactDetails

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

Parámetros de Petición

NameTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
contactdetailsArraySi

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveContactDetails&sld=exampledomain&tld=com&contactdetails[Registrant][Name]=John%20Doe&contactdetails[Registrant][Company]=Company%20name&contactdetails[Registrant][Address]=Address&contactdetails[Registrant][City]=Amsterdam&contactdetails[Registrant][Country]=NL&contactdetails[Registrant][Zip_Code]=1001 GT&contactdetails[Registrant][Email][email protected]&contactdetails[Registrant][Telephone]=N/A' --compressed

Ejemplo de Respuesta:

{"result":"success","Registrant":{"Name":"John Doe","Company":"Company name","Address":"P.O.","City":"Amsterdam","Country":"NL","Zip_Code":"1001 GT","Email":"[email protected]","Telephone":"N\/A"}}

DomainGetLockingStatus

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domaingetlockingstatus&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta:

{"result":"success","lockstatus":"unlocked"}

DomainUpdateLockingStatus

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
lockstatusNull/NumberNoTo lock the domain, set it to ‘1’

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domainupdatelockingstatus&sld=exampledomain&tld=com&lockstatus=' --compressed

Ejemplo de Respuesta:

{"result":"success"}

GetDNS

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetDNS&sld=exampledomain&tld=com' --compress

Ejemplo de Respuesta:

{"0":{"hostname":"*","type":"A","address":"0.0.0.0","priority":null},"1":{"hostname":"mail","type":"MXE","address":"0.0.0.0","priority":"10"},"result":"success"}

SaveDNS

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
dnsrecordsStringSiA 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:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveDNS&sld=exampledomain&tld=com&dnsrecords=czowOiIiOw==' --compressed

Ejemplo de Respuesta:

{"result":"success"}

RegisterNameserver

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
nameserverStringSi
ipaddressStringSi

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RegisterNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com&ipaddress=1.1.1.1' --compressed

Ejemplo de Respuesta:

{"result":"success"}

ModifyNameserver

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

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
nameserverStringSi
currentipaddressStringSi
newipaddressStringSi

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=ModifyNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com&currentipaddress=1.1.1.1&newipaddress=2.2.2.2' --compressed

Ejemplo de Respuesta:

{"result":"success"}

DeleteNameserver

Una vez más, se invoca esta función cuando se solicita un servidor de nombres que desea borrar.

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
nameserverStringSi

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=DeleteNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com' --compressed

Ejemplo de Respuesta:

{"result":"success"}

GetEmailForwarding

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

NameTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetEmailForwarding&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta:

{"1":{"prefix":"test","forwardto":"[email protected]"},"result":"success"}

SaveEmailForwarding

Además, 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

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
prefixStringSiA base64 encoded serialized array of the prefixes.
base64_encode(serialize(array(0=>”test”))));
forwardtoStringSiA base64 encoded serialized array of the forwards.
base64_encode(serialize(array(0=>”[email protected]”)));

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveEmailForwarding&sld=exampledomain&tld=com&prefix=czowOiIiOw==&forwardto=czowOiIiOw==' --compressed

Ejemplo de Respuesta:

{"result":"success"}

Sync

A continuación, esta función de las acciones de API puede incluir cambios en la sincronización de estado, renovaciones, y fechas de caducidad.

Parámetros de Petición

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=Sync&sld=exampledomain&tld=com' --compressed

Ejemplo de Respuesta:

{"result":"success"}

TransferSync

Seguidamente, se invoca este código de las acciones de API 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

NombreTipo¿Requerido?Descripción
sldStringSiDomain name
tldStringSiSuffix attached to domain name
domainStringSiFull domain name
regperiodIntSiRegistration period

Ejemplo de Solicitud:

curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=TransferSync&sld=exampledomain&tld=com&domain=exampledomain.com&regperiod=1' --compressed

Ejemplo de Respuesta:

{"result":"success"}

Esperamos que este artículo sobre códigos o acciones de API, les haya resultado útil. Más información sobre este y otros temas en Ayuda Hosting.

Este sitio web utiliza cookies para que usted tenga la mejor experiencia de usuario. Si continúa navegando está dando su consentimiento para la aceptación de las mencionadas cookies y la aceptación de nuestra política de cookies, pinche el enlace para mayor información. ACEPTAR

Aviso de cookies
AyudaHosting.online
Estamos en las redes sociales para ayudarte...
¡SÍGUENOS EN FACEBOOK!
¡ÚNETE A NUESTRO GRUPO DE AYUDA HOSTING!
We use cookies to help give you the best experience on our website.
By continuing without changing your cookie settings, we assume you agree to this. Please read our
Ok, I Agree