ドキュメント本文へスキップ
API

プール済みドメインの一覧

このインストールが使い捨てアドレスを発行できるドメインの一覧。認証に使えるものを何も持っていない段階で呼び出すエンドポイントです。

GETapi.openemail.uk/temp-mail/domains

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

GET /temp-mail/domains

このインストールが使い捨てアドレスを発行できるドメインの一覧。認証に使えるものを何も持っていない段階で呼び出すエンドポイントです。

認証情報なし

shell
export OE=https://api.openemail.uk

Authorization ヘッダーは一切送りません。この API でヘッダーなしに応答する唯一のリソースです。スコープを与えるのではなくキー検査より前に登録されているのは、ここで提供されるのがアドレスをまだ持っていない人のためのアドレスだからです。先にキーを求めれば、それはツールの皮をかぶった問い合わせフォームになってしまいます。

登録済みかつ検証済みのものだけです。未検証のドメインは何も受信しないため、それを提供することは、黙って動かないアドレスを渡すことになります。受け取った側から見れば、製品が壊れているのと区別がつきません。

curl
curl "$OE/temp-mail/domains"
レスポンス
{  "object": "list",  "data": [{ "object": "temp_domain", "domain": "freemailaddress.com" }]}

空のリストはエラーではなく、行のない 200 です。「このインストールには使い捨てドメインがない」というのはインストールについての事実であり、クライアントは例外を捕捉せずにそれを読めるべきです。503 を返すのは受信箱を作成する呼び出しのほうです。

作成時にこのうちのいずれかを domain として渡すか、何も渡さずにプールに選ばせてください。運用者自身の並び順以外に、順序の保証はありません。