外部連携 ヘルプ
概要
外部連携タブでは、サイトコントローラー(宿泊管理システム)とUnlockOSを連携し、予約データの自動インポートや鍵PINの自動配信を設定できます。現在は ねっぱん! プロバイダーに対応しています。
このタブでできること:
- サイトコントローラーのAPIアカウント情報を登録する
- 同期モード(1方向インポートのみ / 2方向インポート+PIN配信)を選択する
- 外部プロバイダーの部屋をUnlockOSの部屋にマッピングする
- 最終同期日時・ステータスの確認と手動同期の実行
- 同期ログ履歴の確認
- 連携設定の削除
このタブはプラットフォーム管理者のみアクセス可能です(
tab_integrationsフィーチャーフラグで制御)。
アクセス方法
接続設定 → 外部連携 タブ
詳細機能
機能1: プロバイダーの選択
連携設定が未登録の場合、最初にプロバイダーを選択するカードが表示されます。現在対応しているプロバイダー:
| プロバイダー | 説明 |
|---|---|
| ねっぱん! | 旅館・ホテル向け宿泊管理システム(サイトコントローラー) |
プロバイダーカードをクリックすると設定フォームが開きます。
機能2: API資格情報の設定
プロバイダーを選択すると、連携設定フォームが表示されます。
ねっぱん!の設定項目
| 項目 | 説明 | 例 |
|---|---|---|
| APIドメイン | ねっぱん!サーバーのドメイン名 | www48(https://www48.neppan.net となる) |
| ユーザーID | ログイン用のユーザーID | - |
| パスワード | ログイン用のパスワード | - |
| ユーザーコード | ねっぱん!のユーザーコード | - |
| 宿泊施設コード | ねっぱん!の宿泊施設コード | - |
| マスターユーザーコード | PIN配信に使用するマスターアカウントのユーザーコード | - |
| マスターユーザーパスワード | マスターアカウントのパスワード | - |
既存設定の更新時: ユーザーIDとパスワードのフィールドが空の場合、保存済みの暗号化された認証情報がそのまま保持されます。認証情報を変更する場合のみ入力してください。
有効化チェックボックス
有効 チェックボックスをオンにすると、定期自動同期が開始されます。初めて有効化すると、予約管理の チェックインタブ へ案内する緑色のバナーが表示されます。チェックインタブでゲスト向けのチェックインURLを確認・コピーしてください。
オフのままでも手動同期は実行できます。
保存・接続テスト
| ボタン | 説明 |
|---|---|
| 保存 | 設定を保存します。新規登録時はユーザーIDとパスワードが必須です |
| 接続テスト | 保存済みの認証情報でAPIへの接続を確認します(設定保存後に使用可能) |
機能3: 同期モードの選択
| モード | 説明 |
|---|---|
| 1方向(インポートのみ) | ねっぱん!から予約データをUnlockOSにインポートします |
| 2方向(インポート+PIN配信) | インポートに加え、UnlockOSで発行した鍵PINをねっぱん!に自動送信します |
2方向モードを使用する場合は、マスターユーザーコードとマスターユーザーパスワードの設定が必要です。
機能4: 同期ステータス
設定が登録済みの場合、同期ステータスカードが表示されます。
| 項目 | 説明 |
|---|---|
| 最終同期 | 直近の同期が完了した日時 |
| ステータス | 同期結果(success / error / 未実行) |
| 今すぐ同期 | 手動で即時同期を実行するボタン |
同期でエラーが発生した場合、エラーの詳細メッセージがステータスカードの下部に表示されます。
機能5: 部屋マッピング
ねっぱん!の客室をUnlockOSの部屋に対応付けます。正しくマッピングされた部屋の予約のみがインポートされます。
部屋データの取得
- プロバイダーから部屋を取得 ボタンをクリックします。
- ねっぱん!から客室マスターデータが取得され、一覧に表示されます。
- 各外部客室に対応するUnlockOSの部屋をドロップダウンから選択します。
- マッピングを保存 ボタンをクリックして確定します。
ゲストフォームの ON/OFF
部屋マッピングセクションの上部に ゲストフォーム トグルがあります。このトグルで、この連携を通じてチェックインするゲストにゲストフォームの入力を要求するかどうかを一括で設定できます。
| 状態 | 説明 |
|---|---|
| ON(緑) | ゲストはセルフチェックイン時にパスポート・氏名・住所などのフォームを入力する必要があります |
| OFF(グレー) | ゲストフォームの入力をスキップしてチェックインできます |
宿泊施設の法令では本人確認が義務付けられているため、デフォルトはONです。
部屋マッピングテーブルの列
| 列 | 説明 |
|---|---|
| 外部客室名 | ねっぱん!側の客室名または客室ID |
| タイプ | ねっぱん!側の客室タイプ名 |
| UnlockOS部屋 | 対応するUnlockOSの部屋(ドロップダウンで選択) |
UnlockOS側の部屋一覧には、施設設定でアクティブになっている部屋のみが表示されます。
機能6: 同期ログ
直近10件の同期ログが一覧表示されます。同期ログは自動同期・手動同期の両方が記録されます。
| 列 | 説明 |
|---|---|
| 日時 | 同期が実行された日時 |
| タイプ | 同期の種別(scheduled / manual など) |
| ステータス | 成功(緑)またはエラー(赤) |
| 作成 | この同期で新規作成された予約件数 |
| 更新 | この同期で更新された予約件数 |
| キャンセル | この同期でキャンセルになった予約件数 |
機能7: 連携の削除
設定カード右上の 削除 ボタンをクリックすると、確認ダイアログが表示されます。確認後、連携設定が削除されます。
連携を削除しても、すでにインポートされた予約は予約一覧・カレンダーから削除されません。
よくある質問
Q: 接続テストが失敗します
以下を確認してください:
- APIドメインが正しいか(ねっぱん!の契約情報を確認)
- ユーザーIDとパスワードが正確か
- ユーザーコードと宿泊施設コードが正しいか
- ねっぱん!側でAPIアクセスが有効になっているか
Q: 同期ステータスが「error」になっています
同期ステータスカード下部に表示されるエラーメッセージを確認してください。よくある原因:
- 認証情報の有効期限切れまたは変更(設定を更新して保存し直してください)
- ねっぱん!サーバーへの接続タイムアウト(しばらく待ってから手動同期を再試行)
- 部屋マッピングが未設定(「プロバイダーから部屋を取得」してマッピングを設定してください)
Q: 予約がインポートされません
- 部屋マッピングが正しく設定されているか確認します。
- 有効 チェックボックスがオンになっているか確認します。
- 今すぐ同期 ボタンで手動同期を実行し、ログを確認します。
- ねっぱん!側で予約が登録されているか確認します。
Q: 2方向モードでPINが配信されません
2方向同期には マスターユーザーコード と マスターユーザーパスワード の設定が必要です。これらのフィールドが空の場合、PIN配信は行われません。
Q: 部屋マッピングのドロップダウンに部屋が表示されません
施設設定でアクティブな部屋が登録されていない場合、ドロップダウンには何も表示されません。施設設定で部屋を追加・有効化してください。
Q: 「プロバイダーから部屋を取得」をクリックしても何も表示されません
ねっぱん!側に客室マスターデータが登録されていないか、設定した接続情報に問題がある可能性があります。接続テストを実行して認証情報を確認してください。
Q: 連携設定後、ゲスト向けのチェックインURLはどこで確認できますか?
予約管理ダッシュボードの チェックイン タブで確認できます。ねっぱん!連携が有効になっていると、そのURLカードが表示されます。コピーボタンでURLをクリップボードにコピーしてゲストに共有してください。
Q: ゲストにフォームを入力させたくない場合はどうすればいいですか?
部屋マッピングセクション上部の ゲストフォーム トグルをOFFにすると、この連携を通じてチェックインするゲストはゲストフォームの入力をスキップできます。ただし、宿泊施設では法令上の本人確認義務があるため、通常はONのままにしてください。