外部API連携

他サービスの顧客、予約、決済、在庫、分析データを取得・送信します。

外部API連携は、FBP内の顧客、予約、注文、決済、在庫、分析データを、外部サービスと決められた形式で受け渡しする機能です。Roundtableでは「どのサービスとつなぐか」だけでなく、「どのタイミングで送るか」「どの項目を正とするか」「失敗時に誰がどう確認するか」を先にそろえると、発注者、実装者、AIに指示する人が同じ前提で連携範囲を決められます。

外部API連携で予約、在庫、決済、分析データの送受信状態を確認している業務画面例

この機能でできること

外部サービスから顧客、予約、決済、在庫、分析などのデータを取得し、FBPのDBへ保存できます。反対に、FBP側で登録、更新、完了した内容を外部APIへ送信し、外部サービス側の顧客情報、予約枠、在庫数、売上、ステータスを更新できます。定期同期、操作ボタンからの手動連携、公開フォーム送信後の即時連携、管理側での再送処理を用途に応じて組み合わせられます。

外部サービスとの境界を、運用担当者が追える形にします。 送った内容、受け取った内容、処理結果、エラー理由、再送可否を記録しておくと、問い合わせや連携失敗時に原因を追いやすくなります。

よくある利用場面

予約や注文を外部サービスへ送る 公開フォームや管理画面で受け付けた予約、注文、申込を、予約管理、EC、在庫管理などの外部APIへ送信します。

外部側の最新データを取り込む 決済結果、在庫数、顧客ランク、利用実績、分析指標などを定期取得し、FBP側の一覧やダッシュボードに反映します。

失敗した連携を確認して再実行する タイムアウト、認証切れ、項目不足などのエラーをログに残し、管理側から内容確認や再送を行えるようにします。

プロンプト例

連携先、送受信の向き、対象データ、実行タイミング、認証方式、保存するログ、失敗時の扱いをまとめて伝えると、実装範囲を決めやすくなります。

プロンプト 予約管理システムとの外部API連携を追加してください。公開予約フォームで予約が確定したら、顧客名、連絡先、予約日時、人数、申込番号を外部APIへ送信してください。外部APIから返る外部予約IDを予約レコードに保存し、送信日時、送信内容、応答内容、結果、エラー理由を連携ログに残してください。管理画面では予約一覧から連携状態を確認できるようにし、失敗した予約は詳細確認後に再送できるようにしてください。認証情報や接続先は設定値から読むようにし、画面やdocsへ直接書かないでください。

この機能を使うときのポイント

データの正顧客、予約、在庫、決済など、FBP側と外部側のどちらを正として扱うかを項目ごとに決めます。

実行タイミング保存直後、決済完了後、夜間の定期同期、担当者の手動実行など、業務に合うタイミングを選びます。

ログと再送送受信内容、結果、エラー理由を残し、同じ内容を安全に再実行できる条件を決めます。

認証と期限APIキー、OAuth、署名、トークン期限など、認証方式と更新時の運用を先に確認します。

この機能を実装するときのコツ

外部API連携では、画面表示の成功と外部送信の成功を分けて扱います。保存処理の中で外部APIが失敗した場合に業務データまで失うのか、いったん保存して未連携として残すのかを決め、運用担当者が後から再送できる状態にします。外部ID、最終連携日時、連携ステータス、エラー要約を対象レコードに持たせ、詳細なリクエストとレスポンスは連携ログへ分けて保存すると、一覧は軽く保ちながら調査に必要な情報を残せます。接続先や認証情報は設定値から読み、テスト環境と本番環境の値をテンプレートやドキュメントへ固定しない構成にします。