快速上手
註冊帳號、驗證網域、建立 API 金鑰,用 curl 或 Node.js SDK 寄出第一封郵件,再用 SES 信箱模擬器測試。
1. 註冊
在 billionsend.com 建立帳號。控制台就在這裡,API 位址是 https://api.billionsend.com。
2. 驗證網域
只能用已驗證的網域寄信。
- 開啟網域,新增你擁有的網域,例如
acme.dev。 - 到你的 DNS 服務商,加入頁面上顯示的 DNS 記錄(DKIM 與 MAIL FROM)。
- 點擊驗證網域。頁面會顯示還缺哪些記錄。
詳見網域。
3. 建立 API 金鑰
開啟 API 金鑰並建立一把。以 bs_ 開頭的金鑰只會顯示一次,請先複製保存。金鑰可以是完整存取或僅限傳送,也能限定為單一網域。
4. 傳送郵件
用 curl:
curl -X POST https://api.billionsend.com/emails \
-H "Authorization: Bearer bs_..." \
-H "Content-Type: application/json" \
-d '{
"from": "Acme <onboarding@acme.dev>",
"to": ["success@simulator.amazonses.com"],
"subject": "Hello from BillionSend",
"html": "<strong>It works!</strong>"
}'
或用 Node.js SDK(npm install @billionsend/node):
import { BillionSend } from "@billionsend/node";
const bs = new BillionSend("bs_..."); // 設定了 BILLIONSEND_API_KEY 時,也可以直接用 new BillionSend()
const { data, error } = await bs.emails.send({
from: "Acme <onboarding@acme.dev>",
to: ["success@simulator.amazonses.com"],
subject: "Hello from BillionSend",
html: "<strong>It works!</strong>",
});
if (error) console.error(error.name, error.message);
else console.log("sent", data.id);
兩種方式都會回傳 { "id": "..." }。在郵件頁面可以看到這封郵件從 queued 變成 delivered。其他語言請見 SDK。
測試
success@simulator.amazonses.com會模擬一次送達,不會真的寄給任何人。加上標籤就能區分不同測試:success+signup@simulator.amazonses.com。- 模擬器郵件仍會計入方案額度。
- 模擬器的
bounce@、complaint@與suppressionlist@會產生真實的退信與投訴:地址會加入你的抑制清單,事件也會觸發你的 Webhook,但模擬器的回饋不會計入你的退信率與投訴率。只用於手動測試,不要放進自動化測試。每個地址只能用一次,要換新地址就加個標籤:bounce+2@simulator.amazonses.com。 example.com下的地址,以及.test或.invalid網域下的地址都收不到郵件。寄往這些地址的請求會被拒絕,並回傳422(見 API 基礎)。