Como é que utilizo e configuro a API do cliente LWS?

Procédure

A API cliente LWS é uma porta de entrada concebida para facilitar a integração com os serviços e produtos oferecidos pela LWS (Ligne Web Services). Esta API permite aos utilizadores encomendar e gerir eficazmente os seus serviços, como a compra de alojamento, a alteração de DNS, etc.

Nesta documentação, guiá-lo-emos através dos passos necessários para obter a sua chave API e começar a utilizar as funcionalidades da API Cliente. Embora se destine mais a programadores, até um principiante pode utilizá-la.

Autenticação na API

Gerar a chave da API

Para evitar um acesso abusivo à API, é necessário obter uma chave API associada à sua conta LWS e definir um ou vários IPs autorizados a utilizar a API. É necessário ter uma conta LWS para poder utilizar a API. Se não tiver uma, vá ao site oficial da LWS para se registar como novo cliente.

Para obter a sua chave API, inicie sessão na sua conta a partir do painel LWS e vá à página "Dados de contacto".

Aqui, clique no separador "API LWS" para aceder à página de gestão do acesso à API.

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

Aqui, clique no botão para gerar a chave. Guarde-a com cuidado para não a perder. Se pretender gerar uma nova, volte a este modo e clique novamente no botão.

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

Autorizar o acesso a um IP

O segundo passo na utilização da API LWS é autorizar um ou mais IPs a utilizar a API. Este é um método adicional de proteção para que alguém que tenha conseguido deitar a mão à sua chave não possa fazer encomendas indesejadas, como comprar domínios para si.

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

Nesta janela, selecione "Produção" e introduza o seu endereço IP. Se não o souber, pode utilizar um site para obter o seu IP atual. Dependendo da rede a que está ligado, o seu IP pode ser diferente, pelo que poderá ter de especificar vários IPs para utilizar a API em todo o lado. Se pretender adicionar o IP para o utilizar no modo de Teste, selecione "Teste".

Uma vez validado, poderá ver e apagar 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 os eliminar.

Utilizar a API de cliente LWS

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

Selecione uma categoria e um comando no menu da esquerda para obter mais informações sobre eles. A parte superior da página contém um resumo da ação e o URL a utilizar para o comando:

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

Se forem necessários outros parâmetros, nomeadamente no corpo do pedido, estes serão igualmente indicados na categoria "body" (corpo).

Todos os comandos devolvem uma mensagem quando são executados. Esta pode ser uma mensagem de erro, uma mensagem de confirmação ou os dados solicitados (no nosso exemplo, informações sobre o domínio). Pode encontrar todos os retornos possíveis para um determinado comando na secção "Respostas" da página:

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

Eis um exemplo de um comando cURL a ser executado no Terminal. Os campos X-Auth-Login e X-Auth-Path devem ser preenchidos com o seu LWS ID e a sua chave API, obtidos anteriormente, respetivamente.

O campo X-Test-Mode é opcional e pode ser removido se não for necessário. Se definido como "true", permite-lhe executar o comando num ambiente de teste sem tomar qualquer ação na sua conta. Isto pode ser útil para ver como a API funciona sem ter de manipular a sua conta. Terá de introduzir uma API de teste no campo X-Auth-Pass se optar por utilizar o modo de teste.

Finalmente, pode utilizar a API diretamente a partir da documentação:

Para isso, introduza o seu LWS ID e a chave API nos campos ApiAuthID e ApiPasswordKey respetivamente, juntamente com todos os parâmetros requeridos pelo comando, depois clique em "ENVIAR PEDIDO API". Para executar o comando no ambiente de teste, introduza "true" no campo TestMode.

Em seguida, verá abaixo o retorno do comando executado:

Comandos pagos

Embora a maioria dos comandos seja gratuita, alguns comandos da API não funcionam sem um crédito pré-pago na conta. Compra de um domínio, renovação de um pacote de alojamento, mudança de pacote, etc. Assim que a ação exigir um pagamento, ser-lhe-á debitado o montante correspondente do seu crédito pré-pago LWS (apenas se a ação for bem sucedida). Uma vez efectuada a encomenda, não é possível voltar atrás. Certifique-se de que sabe o que está a fazer antes de utilizar as encomendas pagas.

A conta pré-paga é atualmente o único método de pagamento aceite pela API. Se não tiver 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 garantir o acesso àAPI do cliente LWS.
• Utilizar aAPI para gerir os seus serviços com o LWS, incluindo a compra de alojamento, a alteração de DNS e muito mais.
• Explore a documentação oficial para descobrir todos os comandos disponíveis e as suas caraterísticas específicas.
• Execute exemplos de como usar a API em diferentes linguagens de programação, como PHP.
• Utilizar a API em modo de teste para experimentar sem afetar a sua conta.
• Compreender que algumas encomendas são cobráveis e requerem um saldo pré-pago suficiente na sua conta.

Com essas informações, você está pronto para explorar totalmente as possibilidades oferecidas pelaAPI do cliente LWS para o gerenciamento ideal de seus serviços on-line. 🚀💻

Obrigado pela leitura! Se tiver alguma dúvida ou quiser partilhar a sua experiência com o LWS Client API, não hesite em deixar um comentário. Seu feedback é valioso para nós e para a comunidade. 🤝📢