Developer Network

Documentação

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

Informações Iniciais

Informações iniciais sobre a API do Email Marketing

Padrão utilizado

Os webservices do Email Marketing utilizam o padrão REST e o formato JSON codificado em UTF-8 para expor os recursos disponíveis.

Tabs são perfeitos para organizar informações em painéis de conteúdo, onde o acesso precisa ser rápido e quando há muito conteúdo sobre um determinado assunto.

Convenções utilizadas

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

  • DOMINIO: domínio do painel de administração do Email Marketing (emailmarketing.locaweb.com.br)
  • ID_CONTA: id da conta, que pode ser obtido na seção de configurações do Email Marketing
  • TOKEN: Seu token pode ser obtido na seção de configurações do Email Marketing

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

Para os webservices que são acessíveis via POST, como o webservice de importação de contatos por exemplo, aconselhamos a utilização de alguma das ferramentas abaixo para simular o post:

Códigos HTTP de retorno

Os webservices do EmailMarketing retornam códigos de erro HTTP abaixo seguidos de uma mensagem de erro:

Codigo Descrição
200 Sucesso
400 Parâmetros inválidos
404 Não Encontrado
401 Não autenticado
403 Não autorizado
409 Conflito
413 Tamanho do corpo da requisição é maior que o esperado
500 Erro interno no servidor

Autenticação

Todos os requests devem ter o parâmetro X-Auth-Token e Content-Type no header com o valor do TOKEN informado na seção de configurações do Email Marketing. Exemplo:

1
2
3
GET: https://DOMINIO/api/v1/accounts
X-Auth-Token: 0f876ds98f76ds98f6ds98
Content-Type: application/json