受信箱チェックに接続する
パブリック API を無料で始めるか、SDK をダウンロードしてください。アカウントや API キーは必要ありません。
無料 API — サインインせずに開始
送信者の電子メールはテストの技術的な入力であり、登録や検証の手順ではありません。 you@example.com を送信元のアドレスに置き換えます。
JavaScript / Python SDK を使用する · ブラウザで実行する
1. 無料のテストを作成する
curl -X POST https://check.live-direct-marketing.online/api/tests -H "Content-Type: application/json" -d '{"email":"you@example.com","senderLinkReports":false,"placementChangeAlertsEnabled":false,"finalReportEnabled":false}'応答には、token、send_to、results_url、およびexpires_atが含まれます。端末を閉じる前に保存してください。この例では、リマインダー/レポート電子メールを無効にします。ログイン電子メールは要求されません。
2. 自分のメールを送信する
確認したいメッセージをそのアドレスから通常の電子メール サービスを通じて send_to のすべてのアドレスに送信します。テストを作成しても、テストは送信されません。
3. 結果を読む
curl https://check.live-direct-marketing.online/api/tests/YOUR_TEST_TOKEN
YOUR_TEST_TOKEN をステップ 1 のトークンに置き換えるか、result_url を開きます。待っている間、数秒ごとにポーリングを続けます。結果、概要、および認証を検査します。端末のステータスだけでは、受信箱の配信を証明できません。トークンを非公開にしておきます。レポートを読むためにアカウントは必要ありません。
400: リクエストを修正します。 429:resetAt / Retry-Afterまで待ちます。テストの作成中にネットワーク障害が発生した場合、結果は不明です。POST は自動的に繰り返されません。ポーリング時にトークンを保持します。全体的な待機タイムアウトにはトークンと最後のスナップショットが含まれるため、サインインせずに再開できます。
ゲスト SDK: JavaScript と Python
保守されているクライアントを直接ダウンロードします。 Node.js 18 以降または Python 3.9 以降。パッケージマネージャー、依存関係、API キーは必要ありません。
JavaScript SDK (.mjs) · Python SDK (.py)
JavaScript
curl -fsS https://check.live-direct-marketing.online/sdk/inbox-check.mjs -o inbox-check.mjs
// Save as check.mjs, replace the sender address, then run: node check.mjs
import { InboxCheck } from './inbox-check.mjs';
const client = new InboxCheck();
const test = await client.createTest({ email: 'you@example.com' });
console.log(test); // Keep token, send_to and results_url.
// Send your own email to ALL send_to addresses before waiting.
// Save the returned token; use the separate read script below.パイソン
curl -fsS https://check.live-direct-marketing.online/sdk/inbox_check.py -o inbox_check.py
# Save as check.py, replace the sender address, then run: python3 check.py
from inbox_check import InboxCheck
client = InboxCheck()
test = client.create_test('you@example.com')
print(test) # Keep token, send_to and results_url.
# Send your own email to ALL send_to addresses before waiting.
# Save the returned token; use the separate read script below.保存したトークンを使用して続行します。別のテストを作成しないでください。
メッセージを送信した後、同じトークンを使用して別のスクリプトを実行します。作成スクリプトを再実行すると、異なるシード アドレスを持つ別のテストが作成されます。
// Save as read.mjs, replace YOUR_TEST_TOKEN, then: node read.mjs
import { InboxCheck } from './inbox-check.mjs';
const client = new InboxCheck();
const report = await client.waitForResult('YOUR_TEST_TOKEN');
console.log(report);# Save as read.py, replace YOUR_TEST_TOKEN, then: python3 read.py
from inbox_check import InboxCheck
client = InboxCheck()
report = client.wait_for_result('YOUR_TEST_TOKEN')
print(report)waitForResult / wait_for_result は、最初に測定されたプロバイダーのスナップショットまたはターミナル結果を返します。部分的な場合もあります。ステータスと結果を検査し、ステータスが完了するまで、または完全な最終レポートが必要な場合は有効期限が切れるまで、同じトークンを使用して getTest / get_test を呼び出し続けます。タイムアウトはそのトークンを使用して再開できます。
これらのクライアントは public /api/tests を使用します。リモート MCP ゲスト ツールもキーなしで動作します。MCP 命令を使用してください。現在のセットアップ オプションはすべて /sdk/integration.json にリストされています。
登録なしの Webhook: ローカル SDK リレー
AI は、このリレーを独自の Node.js 環境にダウンロードして構成できます。 SAVED テスト トークンを読み取り、最終的な完了/期限切れのスナップショットを待ってから、1 つの署名付き check.completed イベントを受信者に送信します。プロセスを実行し続けます。これは、ホストされた Check Webhook サブスクリプションではありません。
Webhook リレーと署名検証ツールをダウンロードするcurl -fsS https://check.live-direct-marketing.online/sdk/inbox-check.mjs -o inbox-check.mjs curl -fsS https://check.live-direct-marketing.online/sdk/inbox-check-webhooks.mjs -o inbox-check-webhooks.mjs
SAVED_TEST_TOKEN と YOUR_RECEIVER を、すでに作成されたトークンと独自の HTTPS レシーバーに置き換えます。 Configure は、ランダムな署名シークレットを使用して新しいプライベート ファイルを書き込みます。既存のファイルの上書きを拒否します。
node inbox-check-webhooks.mjs configure --token SAVED_TEST_TOKEN --url https://YOUR_RECEIVER/hook --config ./inbox-check-webhook.json node inbox-check-webhooks.mjs run --config ./inbox-check-webhook.json
実行する前に、同じプライベート シークレットを使用して受信機を構成します。未処理のリクエスト本文、X-Inbox-Check-Timestamp、および X-Inbox-Check-Signature を確認します。署名は sha256=HMAC-SHA256(secret, timestamp + "." + rawBody) です。古いタイムスタンプを拒否し、event.id を重複排除します。
import { verifyWebhook } from './inbox-check-webhooks.mjs';
// Receiver: use your privately configured shared secret and RAW request body.
const valid = verifyWebhook({
body: rawBody, secret: privateSharedSecret,
timestamp: request.headers['x-inbox-check-timestamp'],
signature: request.headers['x-inbox-check-signature']
});
// Reject invalid signatures before parsing/acting on the event.
// Deduplicate JSON.parse(rawBody).id before processing a valid event.Relay はテストを作成したり、テスト電子メールを送信したりすることはありません。コールバック POST の再試行やリダイレクトの追跡は行いません。コールバックの配信が不確実な場合、エラーにはeventIdが含まれます: 再実行する前にレシーバーを確認してください。ポーリングがタイムアウトした場合は、トークン/構成を保持して同じテストを再開します。メッセージを受信せずに期限切れになった結果は、期限切れの結果のままになります。
オプションのアカウント、より高い制限、マネージド統合
あなたの接続キー
電子メールのリンクを使用してサインインします。最初に確認されたサインインにより、アカウントとキーがアカウントに自動的に作成されます。
基本: デフォルトでは、スクリーンショットなしで、1 日あたり 100 件、1 か月あたり 1,000 件のチェックが行われます。 Account と me_get には、正確な制限と使用量が表示されます。アカウントで無料の 500/5,000 パッケージをリクエストします。承認後に開始されます。
サインイン後に、新しいキーを再度表示してコピーできます。古いキーは引き続き機能しますが、回復することはできません。代替キーを作成し、統合を更新してから、古いキーを取り消します。キーを秘密にしておきます。
1. 接続を確認します
YOUR_API_KEY を実際のキーに置き換えます。 GET /api/v1/me は、このキーの制限と残りのチェックを表示します。チェックは消費しません。
curl https://check.live-direct-marketing.online/api/v1/me \ -H "Authorization: Bearer YOUR_API_KEY"
2. テストを作成する
正常に作成されたテストでは 1 つのチェックが使用されます。 GET /api/v1/providers を使用して、キーで利用可能なプロバイダーを選択します。
curl -X POST https://check.live-direct-marketing.online/api/v1/tests \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"providers":["gmail","outlook"],"recipient_email":"you@example.com"}'3. 自分のメールを送信する
応答には、send_to アドレスと results_url が含まれます。独自のメール サービスから、返されたすべてのアドレスに電子メールを送信します。テストを作成してもメールは送信されません。
4. レポートを開く
results_url を開くか、GET /api/v1/tests/:token を読み取ります。結果の読み取りにはチェックは消費されません。配達時間は異なります。メッセージが欠落していても、配信が成功したという証拠にはなりません。
限界と歴史
Basic の既定の上限は 1 日 100 回、1 か月 1,000 回のチェックです。実際の上限は異なる場合があります。現在のキーは /api/v1/me、すべてのキーはアカウントで確認してください。利用可能なチェック回数は、日次上限の残り回数と月次上限の残り回数のうち少ない方です。
期間は毎日 00:00 UTC と月の最初の日にリセットされます。アカウントには現地時間でのリセットが表示されます。 API リクエストと失敗したリクエストはチェックとは別にカウントされます。
アカウント履歴には、フィルターと 20/50 行ページを使用してリクエストの詳細が 30 日間保存されます。補償範囲はそこに示されている日付から始まります。以前の記録は不完全である可能性があります。リクエストボディ、Cookie、シークレットは含まれません。
より大きな無料パッケージをリクエストする
アカウントで無料パッケージをリクエストしてください。承認後、選択したキーの制限は 1 日あたり 500、1 か月あたり 5,000 になります。これにより、その制限が置き換えられます。チェックを追加したり、使用法をクリアしたりすることはありません。承認されるまでは、現在の制限が残ります。決定は電子メールで届きます。
account:read を持つユーザーバインドキーは、GET /api/v1/account/promo-requests で独自のリクエストを読み取ることができます。読み取りアクセスでは、リクエストの作成または承認は許可されません。サインインしたアカウントを使用してパッケージを要求します。
リクエストが失敗した場合
マネージド API のみ:401 は Bearer キーを確認することを意味し、403 はその権限を確認することを意味します。 quota_exceeded については、両方の制限を確認してください。 Respect429/リトライアフター。サーバーエラーの場合は、作成 POST を繰り返す前に結果を検査してください。サポートに連絡するときは requestId を保持しますが、キーは決して送信しないでください。
完全な API リファレンスと統合
新しいデフォルト キーには、管理者アクセスを必要とせずに、独自の監視を行うための範囲指定されたアクセス許可が含まれています。既存の主要な権限は変更されません。制限付きキーはアカウント設定の明示的なオプションのままです。
高度なリファレンス: エンドポイント、層、コード
OpenAPI には、ルートと利用可能なリクエスト スキーマがリストされています。一部の応答スキーマは宣言されていません。例と実際の応答フィールドを使用してください。マネージド コールは Authorization: Bearer YOUR_API_KEY を使用します。突然変異を監視するには、monitoring:write; が必要です。読み取りには、monitoring:read とユーザーバインドされたキーが必要です。
- GET /api/v1/me
- 主要なメタデータ、機能、許可されたプロバイダー、クォータ、UTC リセット時間。
- GET /api/v1/providers
- このキーで使用できるプロバイダー。
- POST /api/v1/tests
- テストを作成します。 202 応答には、トークン、send_to、results_url が含まれます。
- GET /api/v1/tests
- カーソルを使用してテストをリストし、ページネーションを制限します。
- GET /api/v1/tests/:token
- プレースメント、認証、診断、利用可能なスクリーンショットの URL を読み取ります。
- DELETE /api/v1/tests/:token
- テスト、結果、スクリーンショットを完全に削除します。
- GET /api/v1/monitoring/domains
- Web サイトと Telegram で共有されている、監視対象のドメインをリストします。
- POST /api/v1/monitoring/domains
- ドメインを追加します: {"ドメイン":"example.com"}。
- POST /api/v1/monitoring/domains/:id/pause
- ドメインの監視を一時停止します。
- POST /api/v1/monitoring/domains/:id/resume
- ドメインの監視を再開します。
- DELETE /api/v1/monitoring/domains/:id
- 監視対象のドメインを削除します。
- GET /api/v1/account/promo-requests
- account:read を使用して、独自の無料パッケージ リクエストを読み取ります。
デフォルトの階層
オペレーターは個々のキーをオーバーライドできます。実際の制限には常に API 値を使用してください。
| 階層 | 1日あたり | 月あたり | スクリーンショット |
|---|---|---|---|
| basic | 100 | 1,000 | — |
| pro | 500 | 10,000 | 付属 |
| enterprise | 5,000 | 100,000 | 付属 |
ノード/Python
個別の SDK は必要ありません。キーは秘密の環境変数に保管し、ソース管理には決して保管しないでください。
ノード(フェッチ)
const response = await fetch('https://check.live-direct-marketing.online/api/v1/me', {
headers: { Authorization: 'Bearer ' + process.env.ICP_KEY }
});
if (!response.ok) throw new Error('HTTP ' + response.status);
console.log(await response.json());Python (リクエスト)
import os, requests
response = requests.get(
'https://check.live-direct-marketing.online/api/v1/me',
headers={'Authorization': 'Bearer ' + os.environ['ICP_KEY']},
timeout=30,
)
response.raise_for_status()
print(response.json())互換性
既存の v1 テスト CRUD、プロバイダー許可リスト、スクリーンショット機能、およびキーごとのクォータは引き続きサポートされます。アカウントのサインイン、回復可能な新しいキー、リクエスト履歴、および無料パッケージのリクエストは、既存のキーを変更せずにこの API を拡張します。