機能説明
指定されたドメインとセレクタに該当するDKIMドメインのTXTレコードを取得し、TXTレコードが正しいかどうかを返します。
リクエスト
エンドポイント
/v1/domains/authentications/verify?domain=[URLエンコードしたドメイン]&selector=[URLエンコードしたセレクタ]
HTTPメソッド
GET
リクエストボディ
なし
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| クエリパラメータのバリデーションエラー | 400 |
| 認証失敗 | 401 |
| TXTレコードが間違っている等の理由で正しい検証に失敗した | 403 |
| 存在しないエンドポイント | 404 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| domain | 文字列 | 1 | ドメイン |
| selector | 文字列 | 1 | セレクタ |
| result | 文字列 | 1 |
VALIDATED 検証成功
FAILED 検証失敗 |
| default | 真偽値 | 1 | 優先的に署名に使用するセレクタかどうか |
| bit_size | 数値 | 1 | 鍵のビット長 |
成功
{"code":200,"domain":"example.com","selector":"selectorhere","result":"VALIDATED","default":true,"bit_size":2048}
失敗
{"code":403,"error":"domain or selector not found"}