Informações e instruções das APIs dos produtos Locaweb.
Aprenda a usar a API
https://api.smtplw.com.br/v1
Todas as requisições devem conter o cabeçalho x-auth-token para que sejam aceitas.
Cada conta no SMTP Locaweb possui um token diferente, basta acessar a url https://smtplw.com.br/panel/settings/api.
As APIs utilizam o padrão REST e o formato JSON codificado em UTF-8 para receber e retornar os dados.
Não são suportadas integrações vindas de aplicações frontend para que as informações sensíveis nas chamadas com a API não fiquem expostas.
O processamento das requisições do tipo GET é feito de modo síncrono. Assim, após a requisição a uma dada URL os resultados são imediatamente exibidos.
O processamento das requisições do tipo POST, por sua vez, é feito de modo assíncrono. Para saber o resultado, é necessário acessar a URL que é retornada no cabeçalho Location.
O resultado contém todas as informações do recurso além dos campos status e response, detalhados na documentação de cada recurso.
Recomendamos o uso de uma ferramenta do tipo Rest Client para fazer os testes, por exemplo a extensão Advanced Rest Client do Chrome.
Recomendamos a utilização da ferramenta JSONLint para validar o corpo da requisição que será feita à API.
Lembramos que, ao inserir HTML no campo body da mensagem, é preciso escapar todas as aspas duplas no código utilizando-se \ (barra invertida).
Forma incorreta: "body": "<html><img src="http://meusistema.locaweb.com.br/images/logo.jpg"></html>"
Forma correta: "body": "<html><img src=\"http://meusistema.locaweb.com.br/images/logo.jpg\"></html>"
Você também pode utilizar aspas simples no lugar das aspas duplas.
Forma alternativa: "body": "<html><img src='http://meusistema.locaweb.com.br/images/logo.jpg'></html>"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
POST https://api.smtplw.com.br/v1/messages
content-type: application/json
x-auth-token: 7sd6g8f7sdg78fsdg7fsd
{
"subject": "qualquer titulo",
"body": "qualquer corpo",
"from": "remetente@dominio.com",
"to": "destinatario@dominio2.com",
"cc": [
"cc1@dominio2.com",
"cc2@dominio2.com"
],
"bcc": [
"bcc1@dominio2.com",
"bcc2@dominio2.com"
],
"headers": {
"Content-Type": "text/plain"
}
}
RESPOSTA:
Status: 201 Created
Location: https://api.smtplw.com.br/v1/messages/25
{
status: "ok"
}
---------------------------------
PARA SABER O RESULTADO:
GET https://api.smtplw.com.br/v1/messages/25
x-auth-token: 7sd6g8f7sdg78fsdg7fsd
{
"id": 25,
"from": "remetente@dominio.com",
"to": "destinatario@dominio2.com",
"cc": null,
"bcc": null,
"subject": "teste aaaa",
"body": "testeee",
"headers": {
"x-source": "api",
"x-api-message-id": 25
},
"status": "Enviado",
"response": null
}
A API adiciona automaticamente 2 cabeçalhos a cada mensagem enviada:
- x-source com o valor 'api';
- x-api-message-id com o ID da mensagem
Se preferir, pode optar por utilizar uma biblioteca para facilitar a integração da API junto ao seu código. Por enquanto, disponibilizamos biblioteca apenas para as linguagens abaixo: