TypeScript · Astro

Envie um e-mail a partir de uma rota API do Astro com @messagebird/sdk. Você precisa de uma chave API Bird: crie uma em Developers > Chaves API (Envie seu primeiro e-mail mostra como), depois coloque-a em .env como BIRD_API_KEY.

1. Instale

Exemplo de código

npm create astro@latest my-app -- --template minimal --install --no-git --no-ai --yes
cd my-app
npm install @messagebird/sdk

2. Envie

Crie src/pages/api/send.ts. prerender = false faz essa rota renderizar no servidor, sob demanda; o Astro expõe valores .env em import.meta.env, e BIRD_API_KEY não tem o prefixo PUBLIC_, então permanece apenas no servidor:

Exemplo de código

import type { APIRoute } from "astro";
import { BirdClient } from "@messagebird/sdk";

export const prerender = false;

const bird = new BirdClient({ apiKey: import.meta.env.BIRD_API_KEY! });

export const POST: APIRoute = async () => {
  const msg = await bird.email.send({
    from: "onboarding@messagebird.dev",
    to: ["delivered@messagebird.dev"],
    subject: "Hello from Bird",
    html: "<p>My first Bird email.</p>",
  });

  console.log(msg.id, msg.status); // "em_…", "accepted"
  return Response.json({ id: msg.id, status: msg.status });
};

onboarding@messagebird.dev é o remetente compartilhado de onboarding do Bird e delivered@messagebird.dev é um destinatário de sandbox que sempre entrega: não é necessária verificação de domínio. O SDK infere a região a partir do prefixo bk_us1_ / bk_eu1_ da sua chave (sem URL base para configurar) e gera automaticamente um Idempotency-Key por chamada, então reenvios são seguros.

3. Teste

Inicie o servidor de desenvolvimento e faça um POST para a rota:

Exemplo de código

npm run dev
curl -X POST http://localhost:4321/api/send

Bird aceita o e-mail com um 202 e o entrega de forma assíncrona; sua rota retorna o ID e o status do em_:

Exemplo de código

{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted"
}

Para fazer deploy de rotas sob demanda em produção, adicione um adaptador de servidor como @astrojs/node ou @astrojs/vercel. Builds apenas estáticos não conseguem executá-las.

Próximos passos

SDK de e-mail TypeScript: a superfície completa de e-mail (send, get, list) e o modelo de erros.
Envie seu primeiro e-mail: criação de uma chave API e o conjunto completo de endereços de sandbox.
Domínios de envio: verifique seu próprio domínio para envio em produção.
Referência de API de e-mail: o esquema completo de solicitação e resposta.

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico. Os recursos estão em inglês.

Assista ao guiaGetting started with email Entenda o conceitoShould I use a Bird SDK or call the API directly?Explore a funcionalidadeEmail Siga o percurso de aprendizagemBuild your first integration

Experimente na prática e obtenha um resumo de implementação