Informação!
Este artigo tem como objetivo orientar na utilização de API em seu Email Marketing Locaweb.
- Este recurso facilita com que você gerencie, manipule e acompanhe as suas campanhas.
Convenções utilizadas
Nas documentações, são utilizadas algumas variáveis, entre elas:
- ID Conta, chave de acesso e endereço de URL:
Pode ser obtido pelo painel do Email Marketing.
- Acessa a plataforma do Email Marketing, no Menu clique em Configurações.
- Clique em Chave da API.
Como testar requisições
- 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:
- Advanced Rest Client – Google Chrome
Validação do JSON
- Existem ferramentas especificas para validar o código JSON utilizado, como por exemplo: jsonformatter.
Códigos HTTP de retorno
- Os webservices do Email Marketing retornam códigos de erro HTTP, seguidos de uma mensagem, conforme abaixo:
Autenticação
- Todos os requests (requisições) devem ter o parâmetro X-Auth-Token e Content-Type no header com o valor da Chave de Acesso informado na seção de configurações do Email Marketing:
Exemplo:
GET: https://DOMINIO/api/v1/accounts X-Auth-Token: 0f876ds98f76ds98f6ds98 Content-Type: application/json
- Veja mais informações e procedimento acessando nosso Developer.
Conheça!
Aproveite e conheça outros produtos da Locaweb, como o Hospedagem de Sites, Clique aqui e saiba mais!