API
クイックスタート
キーの発行と最初の送信。
1. キーを作成する
- 設定 → API keys を開きます。このページは、あなたがそのメールボックスのオーナーである場合にだけ表示されます。
- そのキーを使うものの名前を付けます。何かを失効させる必要が生じたとき、その名前が手がかりになります。
- スコープを選びます。既定では送信のみです。
- 必要なら、送信元にできる範囲を絞ります。ドメイン全体、個別のアドレス、またはその両方です。ドメイン全体は、後から追加されたアドレスも対象にします。
- キーをコピーします。表示は一度きりで、復元はできません。保存されるのは一方向ハッシュです。後でキーをローテーションした場合も、同じように置き換え後のキーが一度だけ表示されます。
2. 何か送ってみる
npm install @openemail/sdk任意です。すべてのエンドポイントはプレーンな HTTP と JSON であり、下の curl タブは何もインストールしなくても動きます。
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'200 なら送信済みです。id が返ります。これは保存してください。メッセージの取得、イベント履歴の閲覧、予約した場合のキャンセルに使います。
思い当たらない 403 が返りますか。GET /addresses は、このキーが送信元にできるものを正確に一覧します。原因はたいてい、ワークスペースにドメインがないことではなく、キーの送信スコープか、キーに与えられていないドメインやアドレスです。