リアルタイム検出
リアルタイム検出は、1つの識別子について1つの問いに即座に答えます。この電話番号、またはこのメールアドレスは、特定のプラットフォームに登録されているか。
エンジンはコンソールが使用しているものと同じです。電話番号またはメールアドレスを受け取り、1〜10個のリアルタイムプロダクトに対して照合し、プロダクトごとの判定を返します。
| 持っているもの | 使うもの |
|---|---|
| 識別子が1つ、または少数で、すぐに結果が必要な場合 | リアルタイム |
| 数千個の識別子があり、待てる場合 | バルク検出 |
リアルタイムの典型的な用途は、サインアップやチェックアウト時のフォーム検証、社内ツールでの単発の照会、すでに稼働中のワークフロー内での少数のチェックです。バルクはファイルと大きな配列向けに作られており、非同期で、検査した行ごとに課金され、完了したタスクはダウンロードできます。
2つのシリーズ、1つの契約
Section titled “2つのシリーズ、1つの契約”シリーズはパスに含まれ、選択するプロダクトと一致している必要があります。
| シリーズ | Endpoint | identifier |
|---|---|---|
| 電話 | POST /v1/realtime/check/phone | E.164 形式の番号。例: +8613800138000 |
| メール | POST /v1/realtime/check/email | メールアドレス。例: user@example.com |
1つのリクエストでシリーズを混在させることはできません。同じ呼び出しで電話プロダクトとメールプロダクトを選択すると拒否されます。country は完全な E.164 番号では任意で、メールでは 省略する必要があります。
1回の呼び出しの課金方法
Section titled “1回の呼び出しの課金方法”1回の呼び出しは 1つの識別子 と 1〜10個のプロダクト を取ります。
- 呼び出しにつき1つの
request_id results内のプロダクトごとに1つのエントリ- エントリごとに1つの課金
各エントリは個別に課金されるため、1回の呼び出しが一部のプロダクトでは成功し、別のプロダクトでは失敗することがあります。これは status: partial_succeeded として報告され、各エントリは独自の billing_status を持ちます。HTTP 200 だけを信じず、これらを確認してください。
このセクションのページ
Section titled “このセクションのページ”- 電話リアルタイムチェック — 電話エンドポイントの詳細
- メールリアルタイムチェック — メールエンドポイントの詳細
- リアルタイムプロダクト — 選択できるプロダクトの最新一覧と、そこから ID を読み取る方法
- 冪等性とリトライ —
Idempotency-Keyが必須な理由と、リトライの動作 - 課金と返金 — 何が課金され、何が返金されるか、そのタイミング
- cURL / SDK の例 — よくあるケースのコピー&ペースト用呼び出し
最初の呼び出しの前に
Section titled “最初の呼び出しの前に”- API キーを用意してください — 認証 を参照。
- 使用する予定のプロダクト ID を リアルタイムプロダクト から読み取ってください。
- すべての呼び出しで一意の
Idempotency-Keyを送信してください。任意ではなく必須です。