API REST Integration
O Mailee pode ser integrado a qualquer aplicação online por meio de sua API REST. Com ela, você poderá manter seus contatos sincronizados com o Mailee de forma transparente.
Se você possui uma conta de agência, confira a nossa API criada especialmente para agências, com comandos especiais.
Este tutorial será útil caso você queira fazer a sua própria integração.
A API do Mailee está em sua versão 2.0, com mais recursos e possibilidades. Assim, esperamos que você não encontre nenhum bug, mas se isso acontecer é só avisar o nosso suporte para corrigirmos o mais rápido possível :)
Como acessar
A API está acessível pelo seguinte endereço do RapidAPI - https://rapidapi.com/mailee/api/mailee-client-v2.
Todas as ações da API REST retornam JSON.
Recomendamos que os acessos sejam sempre feitos por https para garantir a segurança das informações trafegadas.
Parâmetros de acesso
Para usar a API, o Mailee gera uma chave secreta para cada cliente. Para pegar esta chave, vá em Minha conta, depois em Integração e por fim clique em “ver” na opção REST.
Tome muito cuidado com esta chave, ela é tão ou mais importante que a sua senha. Com ela, alguém mal intencionado poderá ter acesso aos seus dados.
Nesse caso, conforme a imagem acima, a chave de acesso seria apenas 7ad275705ac5d. Junto com ela você precisará informar também o subdomínio da sua conta, mailee neste caso.
Atualizando a chave de acesso
Por motivos de segurança, é recomendado atualizar a sua chave a cada 6 meses. Se você já possui código em produção utilizando uma chave, não se preocupe: nós pensamos em você. Quando você cria uma nova chave no Mailee, tanto a chave atual, como esta nova, ficarão ativas. Sendo assim, você pode atualizar seu código, testar e aí então “finalizar” a chave antiga.
Para atualizar sua chave de acesso entre na configuração da integração REST do Mailee (como visto acima) e clique no botão “Gerar nova chave”.
Será gerada uma nova chave de acesso, conforme imagem abaixo:
Agora, ambas as chaves estão ativas e você já pode atualizar o seu código com a chave nova. Quando terminar, basta clicar em Validar esta chave, tornando esta a atual e desativando a chave antiga.
RapidAPI
A nossa API está disponível no RapidAPI. Lá você encontra as mais diversas APIs disponíveis, podendo acessá-las através de um único login. O site também oferece uma completa documentação sobre as APIs, incluindo exemplos de todos os métodos, em diversas linguagens de programação e a possibilidade de testá-los diretamente.
Iniciando sua API
Para verificar a documentação de nossa API dentro do RapidAPI, primeiramente você precisará criar uma conta dentro do mesmo, acessando https://rapidapi.com/ e clicando em sign up.
Feito isto, basta acessar sua nova conta dentro do RapidAPI, pelo próprio link que acessou para efetuar seu cadastro.
Após criar e acessar sua conta, clique em My Apps e crie uma nova aplicação.
Por padrão haverá uma aplicação intitulada *Default* já criada, sugerimos que você crie uma nova aplicação para isto.
No campo de pesquisa digitar “Mailee” e pressionar a tecla Enter.
Sua tela será direcionada para duas opções:
Basta selecionar a opção do seu interesse e clicar sobre ela.
Para víncular a API do Mailee a sua, você terá que efetuar dentro de nossa API um “Test Endpoint”, selecionando em X-RapidAPI-Key, a aplicação que você criou e inserindo sua chave de acesso e subdomínio (api_key e subdomain) nos campos solicitados. Além das demais informações.
Desmembrando opções
O Mailee oferece duas opções de API: para clientes finais e para agências. A API de agências é utilizada para gerenciar os processos de agência, mas, mesmo clientes com este perfil devem usar a API para clientes finais para se conectar ao sistema de seus clientes.
API para clientes
Reports
Aqui você terá todas as opções disponíveis sobre as mensagens enviadas.
Transactional_deliveries
Este deve ser usado para enviar mensagens transacionais (mensagens para apenas um endereço)
Lists
Aqui você terá todas as opções disponíveis sobre suas listas(criação, exclusão, etc).
Templates
Aqui você terá todas as opções disponíveis para trabalhar com templates(criação, update, etc).
Message
Aqui você terá todas as opções disponíveis sobre a criação, edição e envio de suas mensagens.
Client
Aqui você terá todas as opções disponíveis sobre sua conta.
Contacts
Aqui você terá todas as opções de configuração de contatos.
API para agências
Clients
Aqui você tem todas as opções de manutenção de seus clientes.
Endpoints
Retorna as informações sobre sua agência.
Para verificar a configuração de cada método você precisa entrar com seu subdomínio e sua chave de autenticação, além de informar - quando solicitado - o ID de cada mensagem/template/contato/etc.