Ajuda

Como se integrar a API da MailerWeb?

A API da MailerWeb é construída em HTTP. Nossa API é RESTful e:

  • Usa URLs previsíveis e orientados a recursos.
  • Usa recursos HTTP internos para passar parâmetros e autenticação.
  • Responde com os códigos de resposta HTTP padrão para indicar erros.
  • Retorna JSON .

A MailerWeb publicou bibliotecas para vários idiomas. Você pode usar nossas bibliotecas, ou sua biblioteca HTTP / REST favorita, disponível para sua linguagem de programação, para fazer chamadas HTTP para MailerWeb. Visite nossa seção "Quais Bibliotecas posso utilizar?" para ver as bibliotecas HTTP REST que recomendamos.

Base URL

Todas as chamadas de API mencionadas em nossa documentação começam com um URL base:

https://painel.mailerweb.com.br/api/v1

Autenticação

Ao se inscrever em uma conta, você recebe uma chave de API. Você se autentica na API MailerWeb fornecendo sua chave API na solicitação. Você pode gerenciar sua chave de API na guia "Segurança" na seção Conta do Painel de controle.

A autenticação para a API ocorre via autenticação básica HTTP . Usenome de usuário e sua chave de API é a senha. Aqui está como você usa a autenticação HTTP básica com curl:

curl --dump-header - -H "Content-Type: application/json"\
 -H "Authorization: ApiKey username:API_KEY

ATENÇÃO: Mantenha sua chave da API em segredo!

Formato de data

A MailerWeb retorna um JSON para todas as chamadas de API. O JSON não possui um tipo de data interno, as datas são passadas como cadeias codificadas de acordo com RFC 2822 # página-14Esse formato é nativo do JavaScript e também é suportado pela maioria das linguagens de programação prontas para uso:

'Thu, 13 Oct 2011 18:02:00 GMT'

Erros

A MailerWeb retorna códigos de resposta HTTP padrão.

CódigoDescrição
200Tudo funcionou como esperado
400Solicitação incorreta - geralmente falta um parâmetro necessário
401Não autorizado - Nenhuma chave de API válida fornecida
402Solicitação com falha - parâmetros válidos, mas com falha na solicitação
404Não encontrado - o item solicitado não existe
413Entidade de solicitação muito grande - o tamanho do anexo é muito grande
500, 502, 503, 504Erros de servidor - algo está errado no final do MailerWeb

Retornar para Integração por API

Assine nossa newsletter