Padrão utilizado

Os webservices de servidores utilizam o protocolo HTTPS, o padrão REST e o formato JSON API codificado em UTF-8 para expor os recursos disponíveis.

Convenções utilizadas

Nas documentações, são utilizadas algumas variáveis, entre elas:

• ID_CONTA é o usuário utilizado para acessar os serviços da Locaweb;
• ID_PASSWORD é a senha do usuário, utilizado para acessar os serviços da Locaweb;
• TOKEN é único e obtido na área de API do painel de Servidores Cloud e Dedicados
• DOMINIO é o domínio da API de servidores (https://api-servidores.locaweb.com.br);
• SERVER_NAME é o nome do servidor;

Internacionalização

O retorno padrão das requisições são exibidas em inglês, para exibir mensagens em português é possível passar o parâmetro locale.

Exemplo:

1
  GET: https://DOMINIO/v1/cloud/servers?locale=pt-BR

Como testar requisições POST, PUT, etc..

Para os webservices que são acessíveis via POST, como o webservice de reboot de um servidor virtual, aconselhamos a utilização de algumas das ferramentas abaixo para simular o post:

• Fiddler

• Poster (Plugin para Firefox)

• Postman (Plugin para Chrome)

Códigos de retorno HTTP

Abaixo, estão apresentados alguns códigos de status HTTP e suas descrições.

Em caso de erro, uma mensagem com mais detalhes é exibida no retorno da chamada.