Housing Market API 連携ガイド

リファレンス表、エンドポイントの説明、エラーコード、サンプルは API 仕様から生成されるため、どの言語でも英語のまま掲載しています。名前、パラメーター、コードはすべての言語で共通です。

IP 許可リスト

キーは、そのキーに登録された IP アドレスからのみ使用できます。アドレスはお申し込み時に一つ登録します。

当社からどのアドレスが見えているかを確認するには、サーバーから GET /v1/ping を呼び出してください。レスポンスの address フィールドにそのアドレスが返されます。オフィスやノートパソコンのアドレスではなく、そのアドレスを登録してください。

その他のアドレスからのリクエストは、キーが正しくても ip_not_allowed で拒否されます。IPv4 と IPv6 のどちらのアドレスも使用できます。

登録済みのアドレスはコンソールで変更できます。変更は記録され、回数に制限があるため、安定したサーバーの送信元アドレスを登録してください。クラウドプロバイダーで運用する場合は、固定の送信元アドレスを使用してください。

サーバーがプロキシや NAT ゲートウェイの背後にある場合は、プロキシまたはゲートウェイのアドレスを登録してください。当社から見えるのはそのアドレスだからです。

GET /v1/ping

Check your key and the address we see

Confirms that the key is accepted from the address the request came from, and echoes that address. Use it to check the IP you registered before you build anything else.

Parameters

No parameters.

Responses

StatusDescriptionError codes
200The key is valid and the address is registered.
401The key is missing, unknown or revoked.unauthenticated
403The key is valid but this request is refused.ip_not_allowed key_paused
429A rate limit or a quota has been reached.rate_limited quota_exceeded
503The service cannot answer right now.service_unavailable