A API da MailerWeb é RESTful, desenvolvida em HTTP e projetada para ser simples, segura e flexível, permitindo integrações de forma prática e eficiente.
Características da API
- Utiliza recursos HTTP padrão para envio de parâmetros, autenticação e manipulação de recursos;
- URLs previsíveis e orientadas a recursos;
- Respostas no formato JSON;
- Utilização de códigos HTTP para indicação de sucesso ou falha nas requisições.
Bibliotecas Disponíveis
A Mailerweb disponibiliza bibliotecas oficiais em diversas linguagens de programação, pode-se optar por utilizá-las ou escolher a biblioteca HTTP/REST de sua preferência para realizar chamadas à API.
URL Base da API
- Todas as chamadas de API utilizam a seguinte URL base: https://painel.mailerweb.com.br/api/v1
Autenticação
- A autenticação na API da MailerWeb é realizada por meio de uma chave de API (API Key), que é gerada automaticamente ao criar sua conta na plataforma e é feita via Autenticação Básica HTTP, onde:
- Username - seu usuário Mailerweb
- Senha - sua chave de API
Exemplo de autenticação utilizando curl:
curl --dump-header - -H "Content-Type: application/json" \
-H "Authorization: ApiKey username:api_key" \
⚠️ Atenção: Nunca compartilhe sua chave API.
Formato de Datas
- As datas retornadas pela API estão no padrão ISO-8601-Strict, amplamente reconhecido e suportado pelas principais linguagens de programação.
Exemplo: 2011-03-01 18:02
Tratamento de Erros
|
Código |
Significado |
Descrição |
|
200 |
Sucesso |
Requisição processada com êxito. |
|
400 |
Bad Request |
Falta de parâmetros obrigatórios ou parâmetros inválidos. |
|
401 |
Unauthorized |
Chave de API não fornecida ou inválida. |
|
402 |
Request Failed |
Parâmetros válidos, mas a requisição falhou. |
|
404 |
Not Found |
O recurso solicitado não foi encontrado. |
|
413 |
Payload Too Large |
O arquivo enviado excede o tamanho permitido. |
|
500, 502, 503, 504 |
Server Error |
Erro interno no servidor Mailerweb. |