Como usar e configurar a API Client LWS ?

Procédure

A API Client LWS é uma gateway concebida para facilitar a integração com os serviços e produtos propostos pela LWS (Ligne Web Services). Esta API permite aos utilizadores encomendar e gerir eficazmente os seus serviços, como a compra de alojamentos, a alteração dos DNS e muito mais.

Nesta documentação, iremos guiá-lo através das etapas necessárias para obter a sua chave API e começar a utilizar as funcionalidades da API Client. Embora seja mais orientada para programadores, até um principiante pode utilizá-la.

Autenticar-se na API

Gerar a chave API

Para impedir o acesso abusivo à API, precisará de obter uma chave API associada à sua conta LWS, bem como definir um ou mais IPs autorizados a utilizar a API. É obrigatório possuir uma conta LWS para utilizar a API. Se não for o seu caso, aceda ao site oficial da LWS para se inscrever como novo cliente.

Para obter a sua chave API, ligue-se à sua conta a partir do LWS Panel e vá à página "Api LWS" clicando no seu número LWS (LWS-XXXXXX) no canto superior direito.

Nesta página, poderá ver todos os IPs autorizados a utilizar a API com os seus dados, bem como o saldo da sua conta pré-paga, que poderá ser utilizado para comprar ou renovar os seus domínios e alojamentos adquiridos via API. Para gerar a sua chave API, clique no botão "ver" em frente à opção "Chave API em modo PRODUÇÃO" para abrir uma modal que permite gerá-la.

Aqui, clique no botão para gerar a chave. Guarde-a cuidadosamente para não a perder. Se pretender gerar uma nova, volte a esta modal e clique novamente no botão.

Esta chave permite utilizar a API completa no seu modo normal. Se pretender utilizar a API num ambiente isolado, para a testar, deverá utilizar uma chave em modo TESTE, que pode criar da mesma forma que as de Produção, simplesmente clicando em "ver" frente à linha "Chave API em modo TESTE". Não é possível utilizar a chave de teste em produção e vice-versa.

Autorizar o acesso a um IP

A segunda etapa para poder utilizar a API LWS é autorizar um ou mais IPs a utilizar a API. Trata-se de um método de proteção adicional para que uma pessoa que tenha conseguido pôr as mãos na sua chave não possa fazer comandos indesejados, como comprar domínios em seu nome.

Isto acontece no mesmo local da chave API; desta vez, clique no botão "Adicionar um endereço IP" para abrir a janela de adição de IP.

Nesta janela, selecione "Produção" e depois introduza o seu endereço IP. Se não o souber, pode utilizar um site para obter o seu IP atual. Consoante a rede à qual está ligado, o seu IP poderá ser diferente, pelo que talvez tenha de indicar vários IPs para utilizar a API em qualquer lugar. Se quiser adicionar o IP para o utilizar em modo Teste, selecione antes "Teste".

Uma vez validado, poderá consultar e eliminar os IPs atualmente autorizados a utilizar a API numa tabela na página. Podem ser adicionados até 3 IPs para cada modo. Se pretender adicionar mais, terá de eliminar alguns.

Utilizar a API Client LWS

Pode encontrar a documentação oficial, com a lista de todos os comandos disponíveis e exemplos de utilização para descobrir como usar a nossa API.

Selecione uma categoria e um comando no menu da esquerda para obter mais informações sobre eles. Cada página é composta por várias partes; a parte superior da página contém um resumo da ação, bem como o URL a utilizar para esse comando:

Caso o comando necessite de um parâmetro adicional, isso será indicado abaixo, na secção "Request". No caso do nosso exemplo, o comando espera um nome de domínio no "PATH", o URL do comando (em vez de :domain):

Caso sejam necessários outros parâmetros, nomeadamente no corpo do pedido, eles também serão indicados na categoria "body".

Todos os comandos devolverão uma mensagem após serem executados. Pode ser uma mensagem de erro, de confirmação ou ainda os dados pedidos (no nosso exemplo, as informações sobre o domínio). Pode encontrar todas as respostas possíveis de um comando em particular na secção "Responses" da página :

Para um utilizador avançado, estas informações são tudo o que precisará para utilizar confortavelmente a API. No entanto, com o objetivo de propor a API ao maior número possível de pessoas, sejam principiantes ou especialistas, estão disponíveis exemplos de utilização em várias linguagens de programação, como PHP:

Aqui, trata-se de um exemplo de um comando cURL a executar no Terminal. Os campos X-Auth-Login e X-Auth-Path devem ser preenchidos com, respetivamente, o seu ID LWS e a sua chave API, obtida anteriormente.

O campo X-Test-Mode é opcional e pode ser removido se não for necessário. Permite, se definido como "true", executar o comando num ambiente de teste sem efetuar ações na sua conta. Isto pode ser útil para ver como a API funciona sem, no entanto, realizar manipulações na sua conta. Terá de introduzir uma API Test no campo X-Auth-Pass se optar por utilizar o modo de teste.

Por fim, é possível utilizar a API diretamente a partir da documentação:

Para o fazer, indique respetivamente o seu ID LWS e a sua chave API nos campos ApiAuthID e ApiPasswordKey, bem como todos os parâmetros exigidos pelo comando, e depois clique em "SEND API REQUEST". Para executar o comando no ambiente de teste, indique "true" no campo TestMode.

Obterá então abaixo o resultado do comando executado:

Comandos pagos

Embora a maioria dos comandos seja gratuita, alguns comandos da API não poderão funcionar sem crédito pré-pago na conta. A compra de um domínio, a renovação de um alojamento, a alteração de um plano, ... Sempre que a ação exigir um pagamento, será debitado o montante correspondente do seu crédito pré-pago LWS (apenas em caso de sucesso da ação). Não é possível reverter a operação depois de o comando ter sido executado. Certifique-se de que sabe o que está a fazer antes de utilizar os comandos pagos.

A conta pré-paga é atualmente o único método de pagamento aceite pela API. Se não dispuser de fundos suficientes na sua conta, pode carregá-la na página dedicada.

Conclusão

Agora já sabe como:

• Obter a sua chave API e configurar os IPs autorizados para proteger o acesso à API Client LWS.
• Utilizar a API para gerir os seus serviços na LWS, incluindo a compra de alojamentos, a alteração dos DNS e muito mais.
• Explorar a documentação oficial para descobrir todos os comandos disponíveis e as suas especificidades.
• Executar exemplos de utilização da API em diferentes linguagens de programação, como PHP.
• Utilizar a API em modo de teste para experimentar sem impactar a sua conta.
• Compreender que alguns comandos são pagos e exigem um saldo pré-pago suficiente na sua conta.

Graças a estas informações, está pronto para explorar plenamente as possibilidades que a API Client LWS oferece para uma gestão otimizada dos seus serviços online. 🚀💻

Obrigado por nos ter lido! Se tiver questões ou quiser partilhar a sua experiência com a API Client LWS, não hesite em deixar um comentário. O seu feedback é valioso para nós e para a comunidade. 🤝📢