Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

API de Servidores

A API de servidores tem como principal tarefa centralizar as integrações de infraestrutura da Locaweb, unindo Servidores Dedicados e Cloud Server Pro.

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:

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.

Response code (HTTP status) Descrição
200 - Ok Retorno com sucesso
201 - Created Recurso criado com sucesso
202 - Accepted Requisição irá ser processada assíncronamente
401 - Unauthorized Problema de autenticação (por exemplo, o token da API está incorreto ou ausente). Veja a mensagem de erro para mais detalhes
403 - Forbidden Sem permissão para executar essa requisição
404 - Not Found Não foi encontrado o recurso requisitado
409 - Conflict Houve algum conflíto no que foi passado na requisição
422 - Unprocessable Entity Requisição não pode ser processada
500 - Internal Server Error Erro interno na API. Tente novamente em alguns minutos e se persistir contate o suporte