開発者向け
顧客 API ジョブを送信
キー、冪等性、上限、結果のページネーション。
スコープを限定したキーを使用
本番環境での検証には、submitスコープを持つLiveキーを使用してください。キーはサーバー上で管理し、必要なsubmit、read、balanceスコープのみを割り当ててください。Testキーは予約済みのサンプルアドレスをシミュレートし、プロバイダーへの呼び出しやクレジットの消費は発生しません。
ライブキーの上限には、消費済みのクレジットと受け付け済みの確保分が含まれます。上限に達すると、新しいジョブはクレジットを確保せずに拒否されます。ワークスペースのクレジットは、チェックが処理対象として受け付けられた時点で確保され、ダッシュボードと同じ消費・返却ルールが適用されます。
安全な再試行
ジョブには固定の Idempotency-Key を付けて送信してください。同じ内容で再試行すると、同じジョブが返されます。返されたジョブ ID を使って、状態とページ分割された結果を取得してください。同じキーを異なるペイロードで再送信すると拒否されます。
運用上の一時停止中は、新しいライブジョブが HTTP 503 live_verification_unavailable で一時的に拒否されることがあり、その際クレジットは確保されません。後ほど同じべき等キーで再試行してください。これはAPIキーの権限、キーの上限、レート制限とは別のものです。