Housing Market API 連携ガイド
リファレンス表、エンドポイントの説明、エラーコード、サンプルは API 仕様から生成されるため、どの言語でも英語のまま掲載しています。名前、パラメーター、コードはすべての言語で共通です。
認証
すべてのリクエストで、キーを x-api-key ヘッダーに含めて送信してください。
キーはサーバー上で保管してください。モバイルアプリ、ウェブページ、公開リポジトリには絶対に含めないでください。キーを持っている人は誰でも、お客様のサブスクリプションを利用できてしまいます。
キーは一顧客のみに帰属します。他の会社と共有しないでください。共有は利用規約で禁止されており、当社はキーがどこから使用されているかを把握できます。
一つのキーに、お客様のすべてのアクセス権（対象国とプラン）が含まれます。国を追加したり上位プランに変更したりするとキーの内容が変わりますが、新しいキーが発行されるわけではありません。
キーがない、不明、または失効している場合は unauthenticated で拒否されます。有効なキーでも、未登録のアドレスから使用された場合は ip_not_allowed で拒否されます。一時停止中のキーは key_paused で拒否されます。
リクエストの例
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"