Housing Market API 整合指南

參考表格、端點說明、錯誤代碼和範例皆由 API 規格產生,在所有語言版本中均保留英文。名稱、參數和代碼在各處完全相同。

取得金鑰

在主控台訂閱即可取得金鑰。無須排隊等候核准,也不必寄送電子郵件。

  1. 登入主控台,或建立帳戶。這與您用於其他 Housing Market 產品的帳戶相同。
  2. 選擇國家(個別國家、某個區域或全球)、版本,以及月繳或年繳。
  3. 輸入您的伺服器呼叫 API 時所使用的 IP 位址。
  4. 接受 API 使用條款。我們會記錄您接受的內容及時間。
  5. 付款。只有在付款成功後才會顯示您的金鑰,且僅顯示一次。

請將金鑰直接複製到您的機密儲存區。我們只保存其單向雜湊值,因此無法再次向您顯示。金鑰的格式如 hma_<prefix>_<secret>。

您可以隨時在主控台建立替換金鑰。建立後,舊金鑰會繼續有效 24 小時,讓您能在不中斷服務的情況下完成切換。

金鑰狀態

  • 啟用中:金鑰可正常使用。
  • 已暫停:金鑰會遭拒絕並傳回 key_paused。原因排除後會自動恢復。
  • 已撤銷:金鑰會永久遭拒絕並傳回 unauthenticated。

如果續訂付款失敗,您的金鑰會在 5 天的寬限期內繼續有效,期間我們會在每個階段寄送電子郵件通知您,之後金鑰將遭暫停。款項結清後,已暫停的金鑰會立即自動恢復。付款爭議會立即暫停金鑰,直到審查完成為止。

新增國家或升級會立即按比例收費,並在付款確認後不久套用至同一把金鑰。移除國家或降級會在下次續訂時生效。