TypeScript · Astro

Wyślij e-mail z trasy API w Astro za pomocą @messagebird/sdk. Potrzebujesz klucza Bird API: utwórz go w Developers > Klucze API (Wyślij pierwszy e-mail opisuje ten proces), a następnie umieść go w .env jako BIRD_API_KEY.

1. Instalacja

Przykład kodu

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

2. Wysyłanie

Utwórz src/pages/api/send.ts. prerender = false sprawia, że ta trasa jest renderowana na serwerze, na żądanie; Astro udostępnia wartości .env w import.meta.env, a BIRD_API_KEY nie ma prefiksu PUBLIC_, więc pozostaje wyłącznie po stronie serwera:

Przykład kodu

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 to współdzielony nadawca onboardingowy Bird, a delivered@messagebird.dev to odbiorca sandboxowy, do którego wiadomości zawsze docierają: weryfikacja domeny nie jest potrzebna. SDK wnioskuje region z prefiksu bk_us1_ / bk_eu1_ Twojego klucza (nie trzeba konfigurować bazowego URL-a) i automatycznie generuje Idempotency-Key przy każdym wywołaniu, więc ponowne wysyłki są bezpieczne.

3. Testowanie

Uruchom serwer deweloperski i wyślij POST do trasy:

Przykład kodu

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

Bird przyjmuje e-mail z kodem 202 i dostarcza go asynchronicznie; Twoja trasa zwraca ID em_ i status:

Przykład kodu

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

Aby wdrożyć trasy renderowane na żądanie na produkcję, dodaj adapter serwerowy, taki jak @astrojs/node lub @astrojs/vercel. Buildy wyłącznie statyczne nie mogą ich obsłużyć.

Następne kroki

TypeScript email SDK: pełna powierzchnia e-mail (send, get, list) i model błędów.
Wyślij pierwszy e-mail: tworzenie klucza API i pełny zestaw adresów sandboxowych.
Domeny wysyłkowe: zweryfikuj własną domenę do wysyłki produkcyjnej.
Dokumentacja email API: pełny schemat żądania i odpowiedzi.

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Obejrzyj przewodnikGetting started with email Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Poznaj możliwościEmail Podążaj ścieżką naukiBuild your first integration

Wypróbuj ćwiczenie i uzyskaj brief wdrożeniowy