他のシステムとつなぐ（API・Webhook）

受注を入れたあと、基幹システムにも同じ内容を入れ直している。そんな二度手間を、つなぐ仕組みでなくす話です。

2つの「つなぎ方」

システムをつなぐ方法は、大きく2つあります。たとえ話で見てみましょう。

名前	たとえ	何をするか
API	窓口に行って、「あの資料をください」と頼む	必要なときに、こちらからデータを取りに行く・置きに行く
Webhook	荷物が届いたら、自動でベルが鳴る	データが登録されたとき、相手に自動で知らせる

相手のシステム→窓口（API）で頼む読む・登録する→アプリのデータ

アプリで記録が登録される→自動で知らせる（Webhook）起きたらすぐ→相手のシステム

この図は、2つのつなぎ方の向きの違いです。上がAPI、下がWebhookで、矢印の向きが逆になっています。

API: こちらから取りに行く・置きに行く

APIは、ほかのシステムが、データを読み書きするための窓口です。たとえば、次のようなことができます。

• 基幹システムから、アプリの記録を読みに来る
• 別のシステムが、アプリへ記録を登録する
• 毎晩、決まった時間に、データを取り出して集計する

相手のシステムが「読みに来る」形なので、タイミングは相手次第です。

Webhook: 起きたことを、自動で知らせる

Webhookは、アプリで何かが起きたとき、あらかじめ決めた相手に、自動で知らせる仕組みです。たとえば、次のような使い方です。

• 受注が登録されたら、基幹システムに送る
• 申請が確定したら、チャットに通知する
• 点検で「否」があったら、保守システムに連絡する

「起きたら、すぐ届く」ので、二重入力をなくすのに向いています。

たとえば、連携の設定は、こんな画面で管理します。

• 上のタブで、Webhook・個人トークン・APIクライアントを切り替える
• Webhookの行に、送り先と、送るきっかけの種類が出る
• 右の「配信ログ」で、送った記録を確かめられる

安全に使うために決めること

つなぐと便利になる分、窓口が増えることにもなります。次のことを、先に決めておきます。

誰の権限で動かすか

連携を扱える人は、役割で決めます。たとえば、役割の表に、その行があります。

• 「APIキーを見る」「Webhookを作る・直す」などの行が並ぶ
• 役割ごとに、できる人を絞れる

連携にも、人と同じように権限が付きます。「見るだけ」でよい連携に、「消す」権限まで持たせないようにします。必要な範囲だけを許します。

鍵の管理

連携には、**鍵（トークン）**を使います。鍵は、パスワードと同じように、人に見られない場所で保管し、使わなくなったら止めます。

失敗したときの対応

相手のシステムが止まっていると、送った内容が届かないことがあります。届かなかったら、あとから送り直せるか、記録を確認できるかが重要です。

変更時の確認

連携先の項目名が変わったり、アプリの項目を直したりすると、連携が止まることがあります。変更する前に、つながっている先がないかを確認します。

次の図は、つなぐ前の確認リストです。上から順に、決まっているかを見ます。

• 連携の目的と、使う人（担当）を決めた
• 連携に渡す権限は、必要な範囲だけにした
• 鍵の保管場所と、止めるときの手順を決めた
• 届かなかったときの確認方法を決めた
• 項目を直す前に、つながっている先を確かめる

まとめ

• APIは、窓口に頼んでデータを読み書きする仕組み
• Webhookは、起きたことを自動で知らせる仕組み
• 二重入力をなくすなら、Webhookが向いている
• 連携にも権限がある。必要な範囲だけを許す
• 鍵の保管・失敗時の確認・変更時の影響を決めておく

Formia でやるなら

Formiaには、REST APIと、登録時に送るWebhookがあります。連携用の鍵（個人トークン・APIクライアント）は、人と同じ権限のしくみに乗り、Webhookは配信ログで確認できます。設定は REST API、Webhook、APIトークン を見てください。

関連する記事

• CSVでほかのツールに渡す
• 現場アプリのセキュリティ
• プロに頼むタイミング