APIドキュメント
シンプルなREST APIで、お問い合わせフォームにメールチェック機能を組み込めます。
概要
| 項目 | 値 |
|---|---|
| エンドポイント | https://contact-reborn.net/api/check |
| メソッド | POST |
| 認証 | Authorization: Bearer <token> |
| リクエスト形式 | application/json |
| レスポンス形式 | JSON |
マイページで発行したAPIトークンを、Authorization ヘッダーに Bearer 形式で指定します。トークンごとに呼び出し上限と有効期限が設定されます。
リクエスト
メールアドレスをJSON形式でPOSTするだけ。Bearer認証トークンをヘッダーに含めてください。
パラメータ
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| string | 必須 | チェック対象のメールアドレス |
cURL
curl -X POST https://contact-reborn.net/api/check \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{"email": "check@example.com"}'
レスポンス
| result | 意味 | 返ってくるもの |
|---|---|---|
| block | 登録されていました | {"result":"block","status":"success","message":""} |
| pass | 登録されていませんでした | {"result":"pass","status":"success","message":""} |
どちらの場合も HTTP ステータスは 200 で、status は success、message は空文字です。
エラーのとき
エラーのときは result が null、status が failed になります。
| ステータス | 内容 |
|---|---|
| 401 | トークンが指定されていない、無効、または利用できない状態です。 |
| 403 | トークンにこのエンドポイントの権限がない、または有効期限が切れています。 |
| 422 | email が指定されていない、またはメールアドレスの形式ではありません。 |
| 429 | 一定時間内の呼び出し回数が上限を超えています。上限はプランごとに異なります。 |
429 Too Many Requests
{
"result": null,
"status": "failed",
"message": "..."
}
サンプルコード
ご利用の環境に合わせて、そのままお使いいただけます。YOUR_API_TOKEN をマイページで発行したトークンに置き換えてください。
PHP
curl
<?php
$ch = curl_init();
$data = [
'email' => 'test@example.com',
];
curl_setopt($ch, CURLOPT_URL, 'https://contact-reborn.net/api/check');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Authorization: Bearer YOUR_API_TOKEN',
]);
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
if (($result['result'] ?? null) === 'block') {
// The address is registered: handle it here
}
WordPress
functions.php
add_filter('wpcf7_validate', 'check_with_contactreborn', 10, 2);
function check_with_contactreborn($result, $tags) {
$submission = WPCF7_Submission::get_instance();
if (!$submission) return $result;
$data = $submission->get_posted_data();
$email = $data['your-email'] ?? '';
if ($email) {
$response = wp_remote_post(
'https://contact-reborn.net/api/check',
[
'headers' => [
'Content-Type' => 'application/json',
'Authorization' => 'Bearer YOUR_API_TOKEN',
],
'body' => json_encode(['email' => $email]),
]
);
if (!is_wp_error($response)) {
$body = json_decode(
wp_remote_retrieve_body($response), true
);
if (($body['result'] ?? null) === 'block') {
$result->invalidate('your-email',
'This email address cannot be used.');
}
}
}
return $result;
}
Node.js
fetch
const response = await fetch(
'https://contact-reborn.net/api/check',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_API_TOKEN'
},
body: JSON.stringify({
email: 'test@example.com'
})
}
);
const data = await response.json();
if (data.result === 'block') {
// The address is registered
}
if (data.result === 'pass') {
// Not registered: continue as usual
}
ご利用にあたって
01
呼び出し回数の上限はプランごとに異なります。
02
照会したメールアドレスは呼び出しログに保存していません。
03
判定結果をどう扱うかはお客様の実装で決められます。Contact/Reborn が送信を止めることはありません。
今すぐ試してみましょう。
無料のスタータープランですぐにAPIをお試しいただけます。