外部サービスとの連携が失敗しても、取りこぼさないために
APIの権限・再送・重複防止・通知を整理し、連携を続けるための設計を説明します。
目次
CMSと別のサービスをつなぐと、どちらかの一時的な不調で処理が止まることがあります。「接続できた」あとに必要なのは、失敗を見つけて、重複させずにやり直す仕組みです。
ここでは、連携を作る開発担当者と決める項目を説明します。使うプラグインに再送や重複防止の機能があるかを確認し、不足する処理をどう用意するか決めてください。
何を、どちらへ送るかを決める
APIはプログラムからデータを読み書きする窓口です。商品情報を取り込む、公開した記事を別サービスへ知らせるなど、連携の向きときっかけを書きます。
「どのデータが正しい元になるか」も決めます。たとえば営業時間を別のサービスで管理しているなら、「営業時間は元のサービスで変更し、CMSにはその内容を取り込む」と書きます。両方で同じ項目を変更できる場合は、どちらを優先するか開発担当者と決めます。
接続に必要な権限だけを渡す
読み取りだけで足りる連携には、読む権限だけで動くかを確認します。接続トークンは、別のサービスがEmDashに接続するときに使う秘密の鍵です。開発担当者と、トークンに許された操作と、接続に使う利用者の役割を確認します。
接続キーはサーバー側の秘密情報として扱い、ブラウザーへ配るコードやログへ含めません。担当者、期限、交換方法、止めたときに影響する連携を記録します。
再送してよい失敗かを見分ける
| 起きたこと | 対応の考え方 |
|---|---|
| 一時的な通信切断 | 待ってから再送する候補 |
| 回数制限に達した | 相手の指定する待ち時間や上限に従う |
| 入力形式が違う | データを直してから送る |
| 権限・認証の失敗 | キーや許可を確認する |
ずっと再送し続けると、費用や負荷が増えます。待ち時間、最大回数、やめたときの通知先を決めます。送信待ちの処理を保存する仕組みを使う場合は、その保存先の管理方法も決めます。
同じ処理を二度行わないようにする
相手では保存できたのに、成功の返事だけが届かないことがあります。再送すると二重登録になるかもしれません。
たとえば「受付番号123」の通知を送り直すとき、同じ番号を付けます。受け取る側が123を登録済みなら、二件目を作らずに済みます。同じ処理を繰り返しても結果が変わらない性質を冪等性(べきとうせい)と呼びます。この例では、同じ通知を再送しても登録件数が増えないようにします。使える方法は、連携先のAPIに合わせて開発担当者が選びます。
人が追いかけられる記録を残す
処理番号、対象データのID、実行日時、成功・失敗、試行回数、次の対応を記録します。個人情報の本文や秘密の接続キーを丸ごと残す必要はありません。
確認用環境で、相手が応答しない場合、同じ通知が二度来た場合、キーが失効した場合を試します。連携先のAPI仕様変更とプラグイン更新の担当者も決めておきましょう。