Housing Market API 連携ガイド
リファレンス表、エンドポイントの説明、エラーコード、サンプルは API 仕様から生成されるため、どの言語でも英語のまま掲載しています。名前、パラメーター、コードはすべての言語で共通です。
キーの取得
キーは、コンソールでお申し込みいただくと取得できます。承認待ちはなく、メールを送る必要もありません。
- コンソールにサインインするか、アカウントを作成します。他の Housing Market 製品でご利用のものと同じアカウントです。
- 対象国(個別の国、地域、または全世界)、プラン、月払いまたは年払いを選択します。
- サーバーが API を呼び出す際の IP アドレスを入力します。
- API 利用規約に同意します。当社は、お客様が何にいつ同意したかを記録します。
- お支払いを行います。キーはお支払いが完了した後にのみ表示され、表示されるのは一度だけです。
キーはすぐにシークレットストアにコピーしてください。当社はキーの一方向ハッシュのみを保存しているため、再表示することはできません。キーは hma_<prefix>_<secret> のような形式です。
コンソールでは、いつでも代わりのキーを作成できます。作成後も古いキーは 24 時間引き続き使用できるため、ダウンタイムなしで切り替えられます。
キーの状態
- 有効: キーを使用できます。
- 一時停止中: キーは
key_pausedで拒否されます。原因が解消されると自動的に再開されます。 - 失効: キーは
unauthenticatedで恒久的に拒否されます。
更新料金のお支払いに失敗した場合、キーは 5 日間の猶予期間中は引き続き使用でき、その間は各段階でメールでお知らせします。猶予期間が過ぎると、キーは一時停止されます。一時停止中のキーは、お支払いが完了するとすぐに自動で再開されます。お支払いに異議申し立てがあった場合は、確認が完了するまでキーが直ちに一時停止されます。
国の追加や上位プランへの変更は日割りで即時に請求され、お支払いが確認されて間もなく同じキーに適用されます。国の削除や下位プランへの変更は、次回の更新時に適用されます。