Once Email API ドキュメント

ドキュメントは公開されています。API キーの作成と実際の呼び出しは一般公開されていません。以下の手順は、API アクセスを明示的に許可され、有効な認証情報をすでに持つテスト担当者だけが対象です。

認証

各リクエストに Authorization: Bearer oe_live_… を付けます。キーの完全表示は一度だけです。Secret Managerに保存し、ブラウザコード、ログ、Gitに置かないでください。

Authorization: Bearer oe_live_your_key

許可済みテスト担当者向けの手順

API アクセスの明示的な許可と、必要最小限の権限を持つ発行済みの有効な認証情報がある場合だけ続行してください。認証情報はプロセスのシークレット管理機構に保管します。アクセス権がなければ資料とダウンロード内容の確認までにとどめてください。一時受信箱を作成し、返されたIDを保存します。
テスト対象システムからそのアドレスへメールを送ります。
バックオフを使って一覧を取得し、短い空ポーリングを避けます。
対象メールを読み、検証後すぐ受信箱を削除します。

非公開ベータのエンドポイント

POST /v1/inboxesGET /v1/inboxes/{inboxId}/messagesGET /v1/inboxes/{inboxId}/messages/{uid}GET /v1/inboxes/{inboxId}/messages/{uid}/attachments/{cid}DELETE /v1/inboxes/{inboxId}

ステータスコード

400

無効なリクエスト

401

キーがないか無効

403

プランまたはリソースが拒否

404

リソースが見つからない

413

応答または添付が上限超過

429

速度制限または月間上限

503

一時的なサービス障害

クライアントの提供状況

TypeScript、Python、Java、Go、.NET、PHP、Ruby のオープンソース候補版を公開しました。Linux、macOS、Windows のネイティブ CI を通過済みですが、各レジストリには未公開です。

課金状況

Developer は Stripe の月額契約と月間 API 枠を使用します。チャージ残高は提供しません。支払いと返金の検証完了まで Live 決済は閉じています。

利用範囲

権限のあるシステムのテストだけに使用してください。スパム、規則回避、アカウント乱用、他人の通信監視、個人データの長期保存は禁止です。

API は本番準備中です

公開ドキュメントや先行版パッケージのダウンロードで API アクセス権が付与されることはありません。API キー作成と実際の呼び出しは一般公開されていません。

SDK を見る料金を見る

API Demo

安全なクロスプラットフォーム例

所有または許可済みテストシステム向け。Windows、Linux、macOS の Node.js 20+ で動作します。

node demos/api/authorized-workflow.mjs
ONCE_EMAIL_API_KEY <- process secret facility
create inbox -> list messages -> finally delete inbox

完全な Demo を開く

完全な使い方

固定版ローカルパッケージを取得

所有または明示的に許可されたアプリだけをテストします。Once Email は受信専用です。

資料とソースは公開、API は管理対象、SDK と Skill はレジストリ外の候補版です。公開ドキュメントや先行版パッケージのダウンロードで API アクセス権が付与されることはありません。API キー作成と実際の呼び出しは一般公開されていません。

展開前に SHA256SUMS を確認します。

パッケージを取得 SHA256SUMS

正確なローカル開始点

node demos/api/authorized-workflow.mjs

取得からクリーンアップまで

所有または許可を確認し local、test、staging だけを使います。
API アクセスの明示的な許可と、必要最小限の権限を持つ発行済みの有効な認証情報がある場合だけ続行してください。認証情報はプロセスのシークレット管理機構に保管します。アクセス権がなければ資料とダウンロード内容の確認までにとどめてください。
取得、検証、展開後に資料を読みます。
Node.js 20+ で Demo を実行しマーカー付きメールを送ります。
期限付きで待ち一意な対象だけを読みます。
finally で削除し削除失敗を別に扱います。

失敗と復旧

400/401/403/404/413/429/503、期限、曖昧さ、抽出、検証、削除を区別し、固定期限内だけ再試行します。

公開ソースを見る実践ガイドを読む