メインコンテンツへ移動

外部システムへのセッションステータスのプッシュ方法

HAPシステムでは、ユーザーがアクティブ（HAPシステムのインターフェースを呼び出す操作がある場合）かつ受信アドレスが設定されている場合に、2分ごとに外部システムへセッション情報をプッシュします。プッシュされる内容には、HAPシステム内のアカウントIDが含まれます。対応するサードパーティユーザーIDが必要な場合は、{HAP}/apidoc/organization/en/#tag/user/operation/getUserRelationByAccountId を参照してください。

1．設定ファイルの作成​

以下のような設定ファイルを作成します。

例：/data/hap/script/volume/wwwapi/appextensions.json

{
  "AppSettings": {
    "SessionWebhookUrl": "プッシュメッセージを受信するAPIアドレス（必須）",
    "SessionWebhookHeaders": {}
  }
}
  • SessionWebhookUrl：必須。例：https://api.domain.com/hooks/NjA0NzdjMDNjMGFjMTE3ZGUwMjRjN2Nl
  • SessionWebhookHeaders：カスタムリクエストヘッダー。任意。

送信フォーマット（POST application/json）は下記の通りです：

{
  "accountId": "HAP内アカウントID"
}

2．設定ファイルのマウント​

マイクロサービスアプリケーションの docker-compose.yaml を編集し、該当の volumes セクションに以下を追加します。

- ./volume/wwwapi/appextensions.json:/usr/local/MDPrivateDeployment/wwwapi/appextensions.json

3．HAPマイクロサービスアプリケーションの再起動​

設定ファイルをマウントした後、必ずHAPマイクロサービスアプリケーションを再起動してください。