メインコンテンツまでスキップ

はじめに

Homesoon サードパーティ API を使うと、パートナー企業は自社システムを Homesoon の workspace と連携し、construction・task・appointment・supervisor・Shabelabo の 音声議事録レコードを管理できます。

ベース URL

環境URL
Productionhttps://api.homesoon.jp/api
Staginghttps://staging.api.homesoon.jp/api
Developmenthttps://develop.api.homesoon.jp/api

すべてのエンドポイントは /v1/third-party/ 配下にあります。

共通仕様

  • レスポンスは必ず次の形式でラップされます。
    {"status": "success", "data": {...}, "meta": {...}, "error": null}
  • エラー時は status"failure" になり、詳細が error に入ります。
  • タイムスタンプは ISO 8601 形式・UTC です。
  • ページネーションは page(1 始まり)と paging(1 ページあたりの件数、最大 100)を使用します。

次のステップ

  1. Origin を登録します — 認証 を参照してください。
  2. POST /v1/third-party/refresh_tokens でアクセストークンを発行してみます。
  3. 各エンドポイントの詳細は API リファレンス を参照してください。