En este artículo de Ayuda Hosting, les haremos una introducción a la API / Módulo (Application Programming Interface) o Interfaz de programación de aplicaciones.
También le puedes echar un vistazo a nuestra guía de acciones de API.
Índice
¿Qué es una API?
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.
Introducción a la API / Módulo
La API del Reseller de Dominios le permite interactuar con nuestro sistema desde su propio WHMCS o programación propia.
Desde la API puede realizar las siguientes operaciones:
- Registrar Dominio
- Transferir Dominio
- Renovar Dominio
- Sincronizar Dominio
- Eliminar Dominio
- Modificar Datos de Contacto
- Obtener Código EPP / Auth
- Obtener / Actualizar Servidores de Nombre
- Registrar Servidores de Nombre
- Obtener / Actualizar Registros DNS
- Modificar Servidores de Nombre
- Eliminar Servidores de Nombre
- Bloquear / Desbloquear Transferencia
- Obtener / Actualizar Reenvío de Email
- Cron de Sincronización de Dominio
Solicitud al Reseller de Dominio / Formato de Respuesta:
En solicitudes, el Reseller de dominios acepta Parámetros Query.
La respuesta de la API la envía en formato de datos JSON.
Autenticación:
Se requiere la clave de API (API key) y la dirección de correo electrónico para la autentificación.
Estos detalles se dan según el proveedor.
URL:
https://ayudahosting.online/domainsResellerAPI/api.php
Ejemplos:
Los siguientes ejemplos se utiliza la herramienta de línea de comandos cURL para ejecutar solicitudes de la API.
Ejemplo de solicitud API:
curl 'https://ayudahosting.online/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=exampledomain@domain.com&action=RegisterDomain&sld=exampledomain&tld=com®period=1&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&adminfirstname=test&adminlastname=test&admincompanyname=company&adminaddress1=addresss&admincity=city&adminstate=region&admincountry=US&adminpostcode=12345&adminphonenumber=1234567890&adminemail=admin@domain.com' --compressed
Ejemplo de respuesta API:
{"result":"success","msg":"Domain has been registered"}Esperamos que este artículo sobre introducción a la API / Módulo, les haya resultado útil. Más información sobre este y otros temas en Ayuda Hosting.
