¿Cómo se utiliza y configura la API de cliente de LWS?

Procédure

La API de cliente de LWS es una pasarela diseñada para facilitar la integración con los servicios y productos ofrecidos por LWS (Ligne Web Services). Esta API permite a los usuarios solicitar y gestionar eficazmente sus servicios, como la compra de alojamiento, el cambio de DNS, etc.

En esta documentación, le guiaremos a través de los pasos necesarios para obtener su clave API y empezar a utilizar las funciones de la API de cliente. Aunque está más dirigido a desarrolladores, incluso un principiante puede utilizarlo.

Autenticarse en la API

Generar la clave de API

Para evitar accesos abusivos a la API, deberá obtener una clave de API vinculada a su cuenta LWS y definir una o varias IP autorizadas a utilizar la API. Debe tener una cuenta LWS para poder utilizar la API. Si no la tiene, vaya al sitio web oficial de LWS para registrarse como nuevo cliente.

Para obtener su clave API, acceda a su cuenta desde el Panel LWS y vaya a la página "Datos de contacto".

Aquí, haga clic en la pestaña "API de LWS" para acceder a la página de gestión de acceso a la API.

En esta página, podrá ver todas las IP autorizadas a utilizar la API con sus datos de acceso, así como el saldo de su cuenta de prepago, que puede utilizarse para comprar o renovar dominios y hosting adquiridos a través de la API. Para generar su clave API, haga clic en el botón "ver" situado delante de la opción "Clave API en modo PRODUCCIÓN" para abrir un modal que le permita generarla.

Aquí, haga clic en el botón para generar la clave. Guárdela con cuidado para no perderla. Si desea generar una nueva, vuelva a este modo y pulse de nuevo el botón.

Esta clave le permite utilizar toda la API en su modo normal. Si desea utilizar la API en un entorno aislado, para probarla, necesitará utilizar una clave en modo PRUEBA, que puede crear del mismo modo que las claves de Producción, simplemente haciendo clic en "ver" frente a la línea "Clave API en modo PRUEBA". No es posible utilizar la clave de prueba en producción y viceversa.

Autorizar el acceso a una IP

El segundo paso en el uso de la API LWS es autorizar una o más IPs para utilizar la API. Este es un método adicional de protección para que alguien que haya conseguido hacerse con tu clave no pueda realizar pedidos no deseados, como comprar dominios por ti.

Esto ocurre en el mismo lugar que para la clave API; esta vez, haz clic en el botón "Añadir una dirección IP" para abrir la ventana Añadir IP.

En esta ventana, selecciona "Producción" e introduce tu dirección IP. Si no la conoces, puedes utilizar un sitio para obtener tu IP actual. Dependiendo de la red a la que esté conectado, su IP puede ser diferente, por lo que es posible que tenga que especificar varias IP para utilizar la API en todas partes. Si desea añadir la IP para utilizarla en modo de prueba, seleccione "Prueba" en su lugar.

Una vez validada, podrás ver y eliminar las IPs actualmente autorizadas para utilizar la API en una tabla en la página. Se pueden añadir hasta 3 IPs para cada modo. Si desea añadir más, deberá eliminarlas.

Utilización de la API del cliente LWS

Para saber cómo utilizar nuestra API, puede consultar la documentación oficial, con una lista de todos los comandos disponibles y ejemplos de uso.

Seleccione una categoría y un comando en el menú de la izquierda para obtener más información sobre ellos. La parte superior de la página contiene un resumen de la acción y la URL que debe utilizarse para el comando:

Si el comando requiere un parámetro adicional, se indicará más abajo, en la sección "Solicitud". En nuestro ejemplo, el comando espera un nombre de dominio en el "PATH", la URL del comando (en lugar de :dominio):

Si se requieren otros parámetros, en particular en el cuerpo de la petición, también se indicarán en la categoría "cuerpo".

Todos los comandos devolverán un mensaje cuando se ejecuten. Puede ser un mensaje de error, un mensaje de confirmación o los datos solicitados (en nuestro ejemplo, información sobre el dominio). Puede encontrar todos los posibles retornos para un comando en particular en la sección "Respuestas" de la página:

Para un usuario avanzado, esta información es todo lo que necesitará para utilizar cómodamente la API. No obstante, con el fin de poner la API a disposición del mayor número de personas posible, ya sean principiantes o expertos, existen ejemplos de uso en varios lenguajes de programación, como PHP :

He aquí un ejemplo de comando cURL para ejecutar en el Terminal. Los campos X-Auth-Login y X-Auth-Path deben rellenarse con su LWS ID y su clave API, obtenidos anteriormente, respectivamente.

El campo X-Test-Mode es opcional y puede eliminarse si no es necesario. Si se establece en "true", le permite ejecutar el comando en un entorno de prueba sin realizar ninguna acción en su cuenta. Esto puede ser útil para ver cómo funciona la API sin tener que manipular su cuenta. Deberá introducir una API de prueba en el campo X-Auth-Pass si decide utilizar el modo de prueba.

Por último, puede utilizar la API directamente desde la documentación:

Para ello, introduzca su LWS ID y su clave API en los campos ApiAuthID y ApiPasswordKey respectivamente, junto con todos los parámetros requeridos por el comando y, a continuación, haga clic en "SEND API REQUEST". Para ejecutar el comando en el entorno de prueba, introduzca "true" en el campo TestMode.

A continuación verá el resultado del comando ejecutado:

Comandos de pago

Aunque la mayoría de los comandos son gratuitos, algunos comandos de la API no funcionarán sin crédito de prepago en la cuenta. Comprar un dominio, renovar un paquete de alojamiento, cambiar un paquete, etc. En cuanto la acción requiera un pago, se le cargará el importe correspondiente de su crédito prepago LWS (sólo si la acción se realiza correctamente). No hay vuelta atrás una vez realizado el pedido. Asegúrese de saber lo que hace antes de utilizar pedidos de pago.

La cuenta de prepago es actualmente el único método de pago aceptado por la API. Si no tiene fondos suficientes en su cuenta, puede recargarla en la página dedicada.

Conclusión

Ahora ya sabe cómo :

• Obtener su clave API y configurar las IP autorizadas para asegurar el acceso a laAPI Cliente LWS.
• Utilizar laAPI para gestionar sus servicios con LWS, incluyendo la compra de alojamiento, el cambio de DNS y mucho más.
• Explore la documentación oficial para descubrir todos los comandos disponibles y sus características específicas.
• Ejecute ejemplos de cómo utilizar la API en diferentes lenguajes de programación, como PHP.
• Utilice la API en modo de prueba para experimentar sin afectar a su cuenta.
• Comprenda que algunos pedidos son de pago y requieren un saldo de prepago suficiente en su cuenta.

Con esta información, ya está todo listo para aprovechar al máximo las posibilidades que ofrece laAPI de cliente de LWS para una gestión óptima de sus servicios en línea. 🚀💻

¡Gracias por leernos! Si tienes alguna pregunta o quieres compartir tu experiencia con la API de cliente de LWS, no dudes en dejar un comentario. Sus comentarios son valiosos para nosotros y la comunidad. 🤝📢