住所検索: 直接モードの準備
/api/v3/address/preparefind
住所準備検索
このエンドポイントは、ダイレクト・モードでのテキストベースの検索を実装します。 直接モードでは、クライアントに一連の資格証明を提供し、これを使用してサード・パーティ・サーバーに直接アクセスします。 (これは推奨モードです。 間接モード(/findの場合)は低速です。) このエンドポイントは、認可されたユーザーにメタ情報を提供します。 この情報を取得した後、クライアント(たとえば、Webブラウザで実行されているJavaScriptコード)は、この情報を使用して、OPCデータ・サービスAV APIを完全にバイパスして、先行入力検索を実装し、サード・パーティ・クラスタに直接アクセスできます。
出力はJSONマップです。 これには、サード・パーティ・サーバーを直接コールするために使用されるパラメータ「Key」が含まれます。 エンドポイント・パラメータには、サード・パーティ・サーバーのエンドポイントを指す完全修飾URLが含まれます。
レスポンスの例 { "Key": "M48BN-SA23445-ASDFASD", "endpoint": "https://third-party-server.com/api/my/Find1.0" }
このレスポンスからアセンブルできる実際の検索リクエストを次に示します : https://third-party-server.com/api/my/Find 1.0 ?Key=M48BN-SA23445-ASDFASD&Text=941
次のステップは、結果を絞り込むことです。 詳細は、「ここは」を参照してください。
リクエスト
この操作にはリクエスト・パラメータがありません。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
- application/json; charset=UTF-8
200 レスポンス
object