¿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.
Índice
- 1 ¿Qué es una API? (Interfaz de programación de aplicaciones)
- 2 Acciones de API
- 2.1 RegisterDomain
- 2.2 RenewDomain
- 2.3 GetNameservers
- 2.4 GetNameservers
- 2.5 SaveNameservers
- 2.6 ReleaseDomain
- 2.7 RequestDelete
- 2.8 GetEPPCode
- 2.9 GetContactDetails
- 2.10 SaveContactDetails
- 2.11 DomainGetLockingStatus
- 2.12 DomainUpdateLockingStatus
- 2.13 GetDNS
- 2.14 SaveDNS
- 2.15 RegisterNameserver
- 2.16 ModifyNameserver
- 2.17 DeleteNameserver
- 2.18 GetEmailForwarding
- 2.19 SaveEmailForwarding
- 2.20 Sync
- 2.21 TransferSync
¿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
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
| 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 |
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=RegisterDomain&sld=exampledomain&tld=com®period=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=admin@exampledomain.com' --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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=RenewDomain&sld=exampledomain&tld=com®period=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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=RenewDomain&sld=exampledomain&tld=com®period=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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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":"john@exampledomain.com","Telephone":"N\/A"}}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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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]=test@exampledomain.com&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":"john@exampledomain.com","Telephone":"N\/A"}}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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=ModifyNameserver&sld=exampledomain&tld=com&nameserver=test.exampledomain.com¤tipaddress=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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
| nameserver | String | Si |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| Name | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=GetEmailForwarding&sld=exampledomain&tld=com' --compressed
Ejemplo de Respuesta:
{"1":{"prefix":"test","forwardto":"test@exampledomain.com"},"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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| Nombre | Tipo | ¿Requerido? | Descripción |
|---|---|---|---|
| sld | String | Si | Domain name |
| tld | String | Si | Suffix attached to domain name |
Ejemplo de Solicitud:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&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
| 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:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=TransferSync&sld=exampledomain&tld=com&domain=exampledomain.com®period=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.
