不動産業務システムと
1日で連携できる API

1連携の全体像

不動産会社（パートナー）が利用中の業務システムから、契約成立イベントを Webhook で Hikkoshi へ通知。Hikkoshi が顧客に招待リンクを自動送信し、引越サポート全機能（ネット・電気・ガス・引越業者・家具家電）を提供。提携で発生する代理店収入は契約紐付きで自動集計、月次でパートナー会社に分配します。

標準フロー

// パートナーシステムでの契約成立
[ パートナー業務システム ] → 契約成立イベント
        ↓ Webhook (HTTPS POST)
[ Hikkoshi API ] /api/v1/webhook/contract-signed
        ↓ 招待リンク生成
[ Hikkoshi ] → 顧客の LINE / メール / SMS へ送信
        ↓ 顧客がリンクをタップ
[ Hikkoshi App ] → 新住所・引越日プリセット済の状態で起動
        ↓ ネット/電気/ガス/業者契約
[ Hikkoshi ] → パートナー紐付き代理店収入を自動集計

2対応システム

主要 4 システムに加え、API/Webhook をサポートする任意の業務システムと連携可能です。

3認証

すべての API リクエストに Authorization: Bearer {API_KEY} ヘッダが必要です。API キーはパートナー登録後に発行されます。

// リクエスト例
curl -X POST https://api.hikkoshi.app/v1/partners/invite \
  -H "Authorization: Bearer hkp_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "customer_email": "..." }'

⚠ Sandbox 用キーは hkp_test_ プレフィックス、本番は hkp_live_

4エンドポイント一覧

{
  "invite_id": "inv_8x9wKp2mLQ",
  "invite_url": "https://hikkoshi.app/invite/8x9wKp2mLQ",
  "qr_code_url": "https://api.hikkoshi.app/v1/qr/inv_8x9wKp2mLQ",
  "expires_at": "2026-05-09T12:00:00Z",
  "partner_attribution_id": "par_yourCompany123"
}

{
  "event": "contract.signed",
  "timestamp": "2026-05-02T14:00:00Z",
  "contract_id": "contract_abc123",
  "partner_source": "itandi | ielove | reapro | atbb | custom",
  "customer": {
    "name": "山田 太郎",
    "email": "yamada@example.com",
    "phone": "+81-90-1234-5678"
  },
  "property": {
    "address": "東京都目黒区...",
    "layout": "1LDK",
    "move_in_date": "2026-05-25"
  }
}

{
  "period": "2026-05",
  "invites_sent": 142,
  "users_activated": 98,
  "avg_progress": 0.62,
  "contracts": {
    "internet": 37,
    "electricity": 29,
    "gas": 22,
    "movers": 41
  },
  "estimated_revenue_share_jpy": 285000
}

5Webhook 仕様

Hikkoshi から貴社システムへ送るイベント。任意のエンドポイントを登録できます。

署名検証

すべての Webhook には X-Hikkoshi-Signature ヘッダで HMAC-SHA256 署名を付与。Webhook シークレットで検証してください。

const signature = req.headers['x-hikkoshi-signature'];
const expected = crypto
  .createHmac('sha256', WEBHOOK_SECRET)
  .update(req.rawBody)
  .digest('hex');
if (signature !== expected) return res.status(401).end();

6エラーコード

7Sandbox / 本番