TypeScript · Astro

Envoyez un e-mail depuis une route API Astro avec @messagebird/sdk. Vous avez besoin d'une clé Bird API : créez-en une dans Developers > Clés API (Envoyez votre premier e-mail vous guide), puis ajoutez-la dans .env sous le nom BIRD_API_KEY.

1. Installer

Exemple de code

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

2. Envoyer

Créez src/pages/api/send.ts. prerender = false fait en sorte que cette route soit rendue sur le serveur, à la demande ; Astro expose les valeurs .env via import.meta.env, et BIRD_API_KEY n'a pas de préfixe PUBLIC_, donc elle reste côté serveur uniquement :

Exemple de code

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 est l'expéditeur d'intégration partagé de Bird et delivered@messagebird.dev est un destinataire sandbox qui aboutit toujours : aucune vérification de domaine nécessaire. Le SDK déduit la région à partir du préfixe bk_us1_ / bk_eu1_ de votre clé (pas d'URL de base à configurer) et génère automatiquement un Idempotency-Key par appel, ce qui rend les envois réessayés sûrs.

3. Tester

Lancez le serveur de développement et envoyez un POST vers la route :

Exemple de code

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

Bird accepte l'e-mail avec un 202 et le distribue de manière asynchrone ; votre route renvoie l'ID em_ et le statut :

Exemple de code

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

Pour déployer des routes à la demande en production, ajoutez un adaptateur serveur tel que @astrojs/node ou @astrojs/vercel. Les builds statiques ne peuvent pas les exécuter.

Étapes suivantes

Guide e-mail TypeScript SDK : la surface e-mail complète (send, get, list) et le modèle d'erreur.
Envoyez votre premier e-mail : créer une clé API et l'ensemble complet des adresses sandbox.
Domaines d'envoi : vérifiez votre propre domaine pour l'envoi en production.
Référence e-mail API : le schéma complet de requête et de réponse.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Regarder le guideGetting started with email Comprendre le conceptShould I use a Bird SDK or call the API directly?Explorer la fonctionnalitéEmail Suivre le parcours d'apprentissageBuild your first integration

Essayez la pratique et obtenez un guide d'implémentation