本文へスキップ
AI-SNS.IO — CHAT SUPPORTAI-SNS.IO — CHAT SUPPORT
AI SNS CHATの使い方

REST APIでAI SNS CHATを拡張する

AI SNS CHAT 編集部公開 8分で読めます

AI SNS CHATのREST APIで何ができるか、APIキーの管理、SSEストリーミング、署名付きWebhook、レート制限、個人情報の扱いまでを実務目線で整理します。

LINE公式アカウントやWebチャットの応対をAIに任せたあと、「自社の予約システムや会員サイトとつなぎたい」「自社アプリの画面にAIの回答を表示したい」という要望が出てくることがあります。標準のチャネル接続だけでは届かない部分を埋めるのが、REST APIです。この記事では、APIで何ができるのか、どう安全に使うのか、そして個人情報保護法(APPI)の観点で何に気をつけるのかを、順を追って整理します。

まずは「APIが必要かどうか」を見極める

最初に確認したいのは、そもそもAPIが必要なのかという点です。AI SNS CHATには、LINE、Instagram、Webチャットのウィジェットなど、多くのチャネルがあらかじめ用意されています。コードを書かずに設定だけで済むなら、そのほうが保守も楽です。

APIを検討する価値があるのは、次のような場面です。

  • 自社のスマートフォンアプリや会員ページに、独自デザインのチャット画面を作りたい
  • AIの回答を、自社の業務システムの画面にそのまま表示したい
  • 会話の発生や担当者への引き継ぎを、自社のシステムに通知として受け取りたい
  • 既存の社内フローに合わせて、問い合わせの処理を自動化したい
標準のチャネル接続
REST API
設定画面だけで完了する
自社で開発・運用が必要
LINEやWebチャットにすぐ導入できる
画面や処理を自由に設計できる
画面のデザインは用意された範囲
自社アプリや業務システムに組み込める
開発担当者がいなくても進められる
開発担当者または委託先が必要
標準のチャネル接続とREST APIの使い分け説明用の例

「まず標準機能で始め、足りない部分だけAPIで補う」という順番が、中小企業や店舗、自治体の現場では現実的です。

APIでできることの全体像

AI SNS CHATのAPIは、JSON形式のREST APIです。回答を少しずつ受け取れるSSEストリーミング(stream=1)に対応しており、イベントの通知にはHMAC署名付きのWebhookと配信ログが用意されています。

大きく分けると、拡張のパターンは三つです。

1. 自社の画面からAIに話しかける

自社サイトやアプリのバックエンドからAPIを呼び、AIの回答を自社の画面に表示します。デザインの自由度が高く、ブランドに合わせた体験を作れます。

2. 自社システムの情報と組み合わせる

たとえば、会員ページにログインしている人からの質問に対して、自社システム側で会員の状態を確認したうえでAIに問い合わせる、といった使い方です。何をAIに渡すかは自社のサーバー側で決められるため、渡す情報を最小限に絞れます。

3. 出来事をWebhookで受け取る

AIの応対や引き継ぎなどのイベントを、自社のシステムへ通知として受け取ります。受け取る側は署名を検証し、正規の通知だけを処理します。

  1. 01お客様が質問する
  2. 02自社サーバーがAPIを呼ぶ
  3. 03AIが回答を返す
  4. 04自社の画面に表示する
API連携の基本的な流れ説明用の例

APIキーを安全に扱う

APIキーは、いわば合鍵です。漏れると第三者があなたのワークスペースの名前でAPIを使えてしまうため、扱いには注意が必要です。

AI SNS CHATでは、APIキーは「Workspace settings → API keys」から発行します。発行時に一度だけ表示される仕組みで、不要になったり漏えいが疑われたりした場合は失効させられます。この機能はHobbyプラン以上で使えます。

運用の基本は次のとおりです。

  1. キーはサーバー側の環境変数や秘密情報の管理機能に保存し、ソースコードには書かない
  2. ブラウザやスマートフォンアプリの中にキーを埋め込まない。必ず自社サーバーを経由させる
  3. 用途ごと、環境ごと(開発と本番など)にキーを分ける
  4. 担当者の異動や委託先との契約終了のタイミングで、キーを見直して失効させる
  5. 表示は一度だけなので、発行したらすぐ安全な場所に保管する

ストリーミングとWebhookを使いこなす

SSEストリーミングで待ち時間を短くする

AIの回答は、文章が長いほど完成までに時間がかかります。stream=1を指定すると、回答が生成されるそばから少しずつ受け取れます。お客様の画面に文字が順に表示されるため、「固まっているのでは」という不安を与えにくくなります。

スマートフォンアプリや自社サイトのチャット画面を作る場合は、まずこの形式を検討するとよいでしょう。

署名付きWebhookは必ず検証する

Webhookは、自社のサーバーに外部から届く通知です。誰でも送れるURLのままでは、偽の通知を送り込まれる恐れがあります。そこで通知にはHMAC署名が付いています。受け取る側は、共有している秘密の値で署名を計算し、一致した通知だけを処理してください。

あわせて、次の点も押さえておくと安心です。

  • 署名が一致しない通知は処理せずに捨てる
  • 同じ通知が重複して届いても二重処理にならないよう、処理を設計する
  • 通知がうまく届かないときは、配信ログで状況を確認する

レート制限を前提に設計する

APIには利用回数の上限があります。公開されている主な制限は次のとおりです。

対象上限
認証1つのIPにつき5分あたり20回
公開チャット1つのIPにつき1分あたり30回
ポーリング1分あたり120回

ここで注意したいのは、公開チャットの制限が「IPごと」である点です。自社サーバーから多数のお客様の問い合わせを中継する構成では、すべてのリクエストが同じIPから届くことになります。想定するアクセス数が多い場合は、事前に負荷を見積もり、必要に応じて制限に当たったときの再試行やキューの仕組みを用意してください。

たとえば、キャンペーン告知の直後に問い合わせが集中する店舗を想定してみます。1分間に30件を超えるリクエストが一つの中継サーバーから出ると、制限に達する可能性があります。これはあくまで仮定の話ですが、「繁忙時にどうなるか」を事前に考えておく価値は十分あります。

また、回答の完了を繰り返し問い合わせるポーリングよりも、ストリーミングやWebhookのほうが、リクエスト数を抑えやすい場合が多くなります。

個人情報とAPIの付き合い方

APIで自社システムとつなぐと、お客様の氏名、連絡先、予約内容などがシステム間を行き来します。APPIの観点から、次の点を最初に整理しておくことをおすすめします。

  • 渡す情報を絞る:AIが回答するのに必要のない情報は、そもそも送らない
  • ログに残さない:自社側のログに、リクエストの本文やAPIキーをそのまま記録しない
  • 保管期間を決める:会話を何日残すかを決めておく。AI SNS CHATには会話の保持期間を設定する仕組みがあり、既定では無期限に保管されるため、運用方針に合わせて見直しましょう
  • 委託先との取り決め:開発を外部に任せる場合は、キーの管理と個人情報の取り扱いを契約で明確にしておく
  • マイナンバーは扱わない:AI SNS CHATでは、エージェントを作る前に特定個人情報(マイナンバー)に関する覚書への署名が必要です。業務でマイナンバーをAIに入力させない運用を徹底してください

AI SNS CHATのセキュリティ対応は、GDPRおよびAPPIを参考に設計されています。ただし、これは法令順守そのものを保証するものではありません。自社の個人情報の取り扱いは、自社の方針と専門家の助言にもとづいて判断してください。詳細はセキュリティのページで確認できます。

AI SNS CHATでAPI連携を始める手順

ここからは、実際にAI SNS CHATで進める手順です。

1. 先に応対の品質を整える

APIを使う前に、AIの回答そのものを整えておきます。エージェントの「Playground」で質問を試し、回答を確認します。ナレッジは、サイドバーの「Data sources」から、ファイル、テキスト、ウェブサイト、Q&Aなどを登録できます。API経由で呼んでも、回答の土台は同じエージェントの設定です。

2. 契約プランを確認する

APIキーの発行はHobbyプラン以上です。無料プランでは使えないため、先に料金のページで条件を確認してください。連携先のサービスを呼び出す「Actions」も、Hobby以上で使え、エージェントあたりの数はプランごとに異なります。

3. APIキーを発行する

「Workspace settings → API keys」でキーを発行します。キーは一度しか表示されないので、その場で安全な保管場所に控えます。万一の漏えいに備え、失効の手順も確認しておきましょう。

4. 開発環境で呼び出しを試す

APIの仕様は、公開されているAPIリファレンスで確認できます。まずは開発用のエージェントを用意し、テスト用のキーで動作を確かめてください。エージェントは複製(Duplicate)できるので、本番の設定をコピーして試験用にするのも一案です。

5. 運用中の確認先を知っておく

  • 各チャネルの会話は「Activity → Chat logs」で確認できます。評価の記録や書き出しにも対応しています
  • 誰がいつ何を変更したかは「Workspace settings → Activity」(オーナーと管理者向け)に記録されます
  • 設定を誤ったときは、エージェントの復元ポイントで元に戻せます(1つのエージェントにつき最大40個)

6. 画面の場所に迷ったら

ダッシュボード上のSynthiaに「APIキーはどこで発行する?」と聞くと、画面の案内を受けられます。担当者が交代したときの引き継ぎにも便利です。

なお、LINE公式アカウントやInstagramは、APIを使わなくても「Channels」から接続できます。こうした標準のチャネルで足りる部分はそのまま使い、APIは自社だけの画面や業務連携に絞って使うと、保守の負担を抑えられます。接続できるサービスの一覧は連携のページにあります。

よくある質問

無料プランでもAPIは使えますか。

APIキーの発行はHobbyプラン以上です。無料プランではキーを発行できないため、まずは標準のチャネル接続で試し、必要になった段階でプランを見直してください。

APIキーを誤って公開してしまったらどうすればよいですか。

すぐに「Workspace settings → API keys」から該当のキーを失効させ、新しいキーを発行してください。そのうえで、自社側のコードや設定を差し替えます。公開されていた期間の利用状況は、あわせて確認することをおすすめします。

Webhookの通知が届かないときはどう調べればよいですか。

まず配信ログで、通知が送信されたかどうかを確認します。送られているのに処理されない場合は、自社サーバー側のURL、署名検証の処理、ファイアウォールの設定を順に点検してください。

お客様の個人情報をAPIに送っても問題ありませんか。

送る情報は、回答に必要な最小限に絞るのが基本です。AI SNS CHATはGDPRとAPPIを参考に設計されていますが、個人情報の取り扱いの適法性は自社の運用によって決まります。社内の方針を整えたうえで、必要に応じて専門家に相談してください。

#REST API#Webhook#システム連携#APPI#AI SNS CHAT

AI SNS CHATで実践してみましょう

自社のコンテンツで学習したAIエージェントを作り、WebサイトやLINEなどにつなげられます。無料で始められ、クレジットカードは不要です。