Sendgrid

Criando uma nova conta e chave de API

Este processo é utilizado por clientes em processo de recebimento do codigo fonte ou para ex-clientes que já possuem o codigo fonte e querem alterar a conta/Chave de API da Plataforma.

Acesse a Sendgrid e crie uma nova conta.
A conta deve ter uma senha de 16 caracteres e com todos os caracteres (letra maiúscula, caractere especial, numero e leta minúscula).
Caso tenha dificuldades em criar a senha, utilize esse site para gerar uma senha automática: Gerador de senhas | LastPass

Ao acessar a conta criada, localize o campo "Settings" e depois cliente em "API Keys":

deff97a9-2df7-4bda-88ae-7791d858661b

Gerando as novas chaves
Clique em "Create API Key".
A
1° chave deverá sem criada em "Full Access", anote a senha pois ao clicar em salvar não será possível visualizar a chave novamente.
Essa chave é responsável pelos envios de e-mails automáticos da plataforma, aqueles que estão em "templates de e-mails".

A 2° chave é "Email Address Validation Access", anote a senha pois ao clicar em salvar não será possível visualizar a chave novamente.

Essa chave é responsável pela validação anti-Spam dos e-mails para garantir que não entre como Spam aos recebedores, essa chave é opcional e é criada apenas em contas pagas na Sendgrid conforme observação abaixo.

382bb858-2b1a-46c7-b6a2-c85eccd0bc79


Obs.: O campo "Email Address Validation Access" é opcional e não impede o funcionamento da plataforma caso não seja criada.
Essa chave não irá aparecer em contas gratuitas, caso deseje criar essa chave também e garantir que os e-mails não caiam como Spam em alguns casos, será preciso assinar o plano Pro ou Premier da Sendgrid:
Sendgrid Pricing Plans

5f12888a-158d-4201-95b0-6279100ad4e9

Obs.: Vale ressaltar que contas gratuitas na Sendgrid possuem limite de 100 e-mails por dia:

a5d75f2e-8423-4c6f-ba02-5a35694f2e3b

Reforçamos que a chave mais importante a ser criada é a chave "Full Access", então se você está em fase de recebimento do codigo fonte, você receberá o codigo fonte após a alteração dessa chave "Full Access", e se caso não fornecer a chave "Email Address Validation Access", deixaremos esse campo vazio ("null") na plataforma, e posteriormente você mesmo poderá inserir uma chave, quando em posse do codigo fonte, seguindo o passo ao final desse artigo.


Se você está em fase de entrega do codigo fonte basta informar ao nosso time de Suporte a(s) chave(s), informando juntamente o titulo da(s) chave(s) (Full Access e Email e/ou Address Validation Access).

247a6542-ef65-46a5-89bf-426e3e9b054f

Após alterar sua chave de API, a Sendgrid exige que os envios de e-mails de sua plataforma sejam a partir de um e-mail autenticado pela sendgrid, que no caso é domínio de sua plataforma.
Para todas as novas contas, o domínio do endereço do remetente usado na integração da API deve sempre usar o domínio autenticado na conta. Isso garantirá que o e-mail esteja alinhado com SPF DKIM para entrega de e-mail perfeita das respectivas contas.
O e-mail deve ser no modelo: "meuemail@seudominio"
Desta forma, insira no painel de customizações um e-mail no modelo acima para garantir os envios de e-mails:

0fd0f28b-dd3c-4a8a-873d-245878c36459

Se você já tem o codigo fonte

  1. Na plataforma acesse em Configurações:

e3ee26e3-01d3-4ebc-9941-a366cdb28489


Em configurações acesse >> Environment >> smtp

Altere o username e password com o login e senha da sua conta Sendgrid que criou anteriormente.

  1. 0e5bc87c-75b6-4809-8ebc-ca640b5a3eef

  2. Em Sendgrid, utilizando as chaves de APIKey criadas, adicione a chave "Full Access" na configuração: sendgridApiKey.

  3. Em sendgridApiKeyForEmailValidations insira a chave "Email Address Validation Access":
    Se não houver essa 2º chave insira: null.

e7bfca59-a1b0-4698-b114-59feea687e42

Obs.: A 1º chave sendgridApiKey é a chave responsável pelo envio dos e-mails, portanto esse campo não poderá ficar como null.


Autenticação de dominio na Sendgrid


Seu dominio é autenticado pela Ideia no Ar durante a fase de implantação conosco, e não é necessário autenticar novamente se seu e-mail faz envios e recebem e-mails normalmente a partir de seu dominio. Mas se desejar autenticar novamente em caso de troca de plataforma de hospedagem, uma nova conta Sendgrid para gerenciar a autenticação, ou por outro fatores, siga o processo abaixo.


1 - Dentro do menu lateral acessar as opções "Settings >> Sender Authentication":

79e390b4-0a1f-4d26-b406-a8bb5ed432b4

2 - Selecionar a opção "Authenticate Your Domain":

035f7c90-b492-44e5-a1e3-02f85b458861

3 - Selecionar qual a ferramenta de apontamento de DNS foi feito o domínio.

Normalmente nossos clientes usam Cloudflare, então esse processo será realizado com o dominio apontado na Cloudflare, mas se seu dominio está apontado em outra hospedagem é só selecionar sua hospedagem na opção abaixo, e em ultimo caso, se não encontrar sua plataforma de hospedagem, selecione "outros".

315b957f-da11-4647-85c4-29f79b95ca97

Após isso, avance para a próxima fase selecionando "NEXT".


4 - Adicionar seu domínio que será validado (importante conferir no lado direito como ficarão os e-mails enviados com este domínio).

f284d200-3332-4ad5-955e-165c9a17515e
99400c7c-c973-4271-b40c-a0154d05e862

5 - Acesse sua conta Cloudflare ou outro gerenciador de DNS. Os dados de acesso estão na planilha de contas entregue junto ao codigo fonte, caso não encontre, provavelmente não foi fornecido esse acesso à Ideia no Ar, mas se tiver problemas com esse acesso basta acionar o suporte da Ideia no Ar.

cbea82af-7f89-4c08-bb55-d02c73bb172b
11f580d5-a42d-4d00-aef9-21ea398fd323

Selecionar a opção de "DNS"

Ir adicionando 1 a 1 os códigos de validação informados pelo Sendgrid.

0572d7bd-06db-4900-894f-f9ff1f2f7caf

Selecionado o tipo como "CNAME" e colando os respectivos códigos de validação na mesma sequencia informada pela Cloudflare.

Proxy status: DNS only.

52919ad4-438a-425e-81bd-bd12ef1d29fc

Após o processo no Cloudflare, deve aguardar alguns instantes e solicitar a validação dentro do Sendgrid. O resultado da validação deve retornar verde; se houver erros, verifique se os registros foram corretamente configurados no painel de DNS e persista na configuração até ter tudo verde.

b9dbccb6-84f5-46c3-9690-c5f61b27614f

Após isso seu dominio estará autenticado.