Introdução à API do SendGrid
Há várias maneiras de começar a usar a API do SendGrid.
Pré-requisitos para enviar seu primeiro e-mail com a API do SendGrid
Estas instruções descrevem como enviar seu primeiro e-mail usando chamadas cURL. Esta é uma das muitas maneiras de enviar e-mails com a API do SendGrid. Além disso, temos bibliotecas PHP, Python, Node.js, Java, C#, Go e Ruby.
Antes de começar a usar a API, você precisa fazer o seguinte:
- Criar uma [conta] no SendGrid(https://sendgrid.com/pricing/).
- Criar uma chave de API.
- Verificar se o curl está instalado no seu equipamento.
O cURL é padrão nos sistemas operacionais Mac.
Como enviar um e-mail usando a API
Crie sua chamada de API
Sua chamada de API deve ter os seguintes componentes:
– Um host: o host para solicitações Web API v3 sempre é https://api.sendgrid.com/v3/
– Um cabeçalho de autorização: uma chave de API deve ser incluída no cabeçalho de autorização.
– Uma solicitação: Ao enviar dados para um recurso via POST ou PUT, você deve enviar o payload em JSON.
Limite de tamanho da mensagem: O tamanho total da mensagem não deve exceder 20 MB. Isso inclui a mensagem em si, os cabeçalhos e o tamanho combinado de quaisquer anexos.
Observe que a autenticação básica não é mais aceita; você deve usar uma chave de API.
Como enviar um e-mail usando a API do SendGrid:
curl --request POST \
--url https://api.sendgrid.com/v3/mail/send \
--header 'Authorization: Bearer <<YOUR_API_KEY>>' \
--header 'Content-Type: application/json' \
--data '{"personalizations":[{"to":[{"email":"john.doe@example.com","name":"John Doe"}],"subject":"Hello, World!"}],"content": [{"type": "text/plain", "value": "Heya!"}],"from":{"email":"sam.smith@example.com","name":"Sam Smith"},"reply_to":{"email":"sam.smith@example.com","name":"Sam Smith"}}'
- Copie o exemplo de curl acima.
- Cole a chamada curl no seu editor de texto de preferência.
- Copie sua chave de API e cole-a no cabeçalho "Authorization" .
- Na seção de dados, especifique os nomes em "to", "from", "reply to" e os endereços de e-mail e digite um assunto.
- Copie o código e cole-o em seu terminal.
- Pressione Enter.
- Verifique a caixa de entrada do endereço de e-mail especificado como "to" e veja sua mensagem!
Se você ainda não configurou a Sender Authentication (Autenticação do remetente) em sua conta, talvez seja necessário procurar o e-mail que acabou de enviar em sua pasta de spam.
Você quer ajuda especializada para que seu programa de e-mail comece com o pé direito?
Com o serviço Email Implementation, você economiza tempo e se mantém confiante de que está preparado para ser bem-sucedido a longo prazo. Nossos especialistas trabalham como uma extensão de sua equipe para garantir que seu programa de e-mail esteja configurado corretamente e fornecendo valor para sua empresa.
SERVIÇOS DE IMPLEMENTAÇÃO →
Mensagens de resposta da API
Todas as respostas são retornadas no formato JSON. Especificamos isso ao enviar o cabeçalho Content-Type
. A Web API v3 fornece uma seleção de opções de códigos de resposta, cabeçalhos de tipo de conteúdo, e paginação para ajudar você a interpretar as respostas às suas solicitações de API.
Obtenha suporte adicional para a integração. Economize tempo, aumente a qualidade do seu envio e sinta-se confiante de que está preparado para o sucesso de longo prazo com o SendGrid Onboarding Services.
Próximas etapas
Para obter mais informações sobre o SendGrid e onde você pode chegar com ele, confira estas páginas:
– Referência à API – Autenticação do remetente – Como automatizar subusuários
Precisa de ajuda?
Às vezes, todos nós precisamos. Receba ajuda agora da equipe de suporte do Twilio SendGrid.
Enfrentando dificuldades de codificação? Confie na sabedoria da multidão navegando pela tag SendGrid em Stack Overflow ou visite o Stack Overflow Collective da Twilio.