基幹連携・データ移行読了約14分

APIキーの期限切れで連携が止まる前に決める管理表【更新担当と日付の記入例】

APIキーや認証の期限で連携が止まる前に作る管理表と更新手順

記事の概要図

月曜の朝、倉庫から「注文が出荷の画面に1件も来ていない」と連絡が入りました。ネットショップの管理画面には注文が入っているのに、受注を出荷システムへ渡す連携だけが金曜の夜から止まっています。調べると、連携に使っていた認証の期限が金曜に切れていて、開発会社に頼んだ当時の担当者もすでに異動していました。

連携は、動いているうちは誰も意識しません。ところが、認証の鍵や許可の期限が切れた日から、静かに止まります。しかも、エラーの通知が誰にも届かない設定だと、週明けまで気づけません。こんなことはないでしょうか。

この記事では、APIキーなどの認証情報の期限で連携が止まるのを防ぐために、発注する側・使う側の担当者が作っておく管理表と、止めずに差し替える手順を説明します。専門用語はできるだけ言い換え、表に書き込む例も示します。

この記事で分かること

  • 連携が期限で止まる原因になる資格情報の種類と、サービスごとに期限が違う理由
  • 期限と通知日を逆算して書く管理表の作り方と、記入例
  • 連携を止めずに新しい鍵へ差し替える手順と、担当者が替わるときの引き継ぎ

1. 連携が期限で止まる資格情報の種類

システム連携では、片方のシステムがもう片方に「このデータを読んでよい」「このデータを書いてよい」と許可をもらうために、何らかの資格情報を使います。呼び方は様々ですが、期限の観点では次の4種類に分けると整理しやすくなります。

APIキー合い鍵サービスにより有り・無し呼び出しが拒否され連携が止まる
アクセストークン当日限りの入館証短い(自動で更新する作り)更新の仕組みが壊れると止まる
リフレッシュトークン入館証を作り直す権利条件で失効する再度の許可画面の操作が必要になる
クライアントシークレット・証明書アプリ自身の合言葉有り(上限あり)認証そのものが通らなくなる

同じ「APIキー」という名前でも、提供元によって扱いが違います。期限がないもの、期限を自分で選べるもの、決まった期間で切れるものがあります。そのため、「うちの連携は大丈夫」と思い込まず、連携ごとに確かめる必要があります。

公式資料から、期限の決まり方の例を3つ挙げます。

  • Googleの認証(OAuth 2.0)の資料によると、リフレッシュトークンは、6か月使われなかった場合に使えなくなります(ほかにも、利用者が権限を取り消した場合などがあります)。また、同意画面のユーザータイプが外部で公開ステータスが「テスト」のプロジェクトでは、有効期限が7日間になります(要求する範囲が名前・メールアドレス・プロフィールに限られる場合は対象外)。
  • Microsoft Entra IDの資料によると、クライアントシークレットの有効期間は24か月以下に制限されており、Microsoftは12か月未満の設定を勧めています。
  • ある配信ツール(MoEngage)の公式資料は、キーの作り直しを、定期的なスケジュールのほか、「キーにアクセスできる人がチームやベンダーから離れるたび」にも行うよう求めています。

つまり、期限は「日付」だけで決まりません。「使われなかった期間」「テスト状態かどうか」「人の出入り」といった条件でも、連携が止まります。

連携が止まる資格情報の4種類と、期限が来る条件

2. 期限が切れると何が起きるか

期限切れの被害は、止まったこと自体より、気づくまでの時間で決まります。たとえば、ネットショップの注文を1日80件、出荷システムへ自動で渡している連携が、金曜の夜に止まったとします。

翌朝(1日)80件80×1出荷の遅れは1日分
週明け(3日)240件80×3出荷の遅れの問い合わせが増える
1週間560件80×7手入力で巻き取るのが難しくなる

この例では、気づくのが1日遅れるごとに、80件の滞留が増えます。手で取り込み直せる件数には限りがあるため、「期限が切れないようにする」ことと、「切れたときにすぐ気づく」ことの両方が必要です。

別の記事で扱った連携エラーの通知の決め方と、この記事の期限管理は、役割が違います。通知は「止まってから知らせる」仕組み、期限管理は「止まる前に更新する」仕組みです。両方がそろって、初めて月曜の朝の電話が防げます。

ステップ1 連携ごとの資格情報を洗い出す

最初の作業は、洗い出しです。自社が使っている連携を全部書き出し、それぞれがどの資格情報で動いているかを調べます。

洗い出しの入口は3つあります。

  • 開発会社との契約書・設計書にある「連携」の項目
  • 各SaaSの管理画面にある「連携アプリ」「API」「開発者向け」のメニュー
  • 経理や営業事務など、現場の担当者が個人で設定した連携(見落とされやすい)

3つめが特に重要です。担当者がZapierや各SaaSの標準連携を自分のアカウントで設定していると、その担当者が退職したときに、連携が止まることがあります。資格情報が「個人のアカウント」に紐づいていないかも、ここで確認します。

記入例です。

受注の出荷システム渡しショップ→出荷APIキー連携専用の共通アカウントショップの管理画面
請求データの会計取り込み販売管理→会計クライアントシークレット開発会社の登録アプリ会計側の開発者画面
予定の同期営業の予定表→共有カレンダーリフレッシュトークン営業事務の担当個人Googleのアカウント画面

3行目は要注意です。個人のアカウントに紐づく連携は、異動や退職で止まりやすくなります。可能なら、連携専用のアカウントを作り、そちらに付け替えてください。

ステップ2 期限と通知日を管理表に書く

洗い出した連携に、期限を書き足します。期限は、提供元の画面の表示か、公式資料の期間から計算して書きます。わからないものは「不明」と書いて、確認の担当を決めます。「不明」を空欄にしないことが重要です。空欄は、確認し忘れた印にしかなりません。

期限が分かったら、通知日を逆算します。通知は、1回では見落とされるので、複数回に分けます。AppMasterの解説では、キーの期限の事前警告の例として14日、3日、24時間前が挙げられています。また、キーの期限が近いことを知らせる通知の例として、7日と1日も示されています。

この考え方を参考に、期限が2027年3月31日のAPIキーの通知日を逆算すると、次の表になります。

1回め(準備)30日前2027年3月1日更新担当・開発会社
2回め(依頼)14日前2027年3月17日更新担当・開発会社
3回め(確認)7日前2027年3月24日更新担当・責任者
4回め(最終)3日前2027年3月28日更新担当・責任者
5回め(緊急)1日前2027年3月30日責任者

3月31日から30日さかのぼると3月1日、14日さかのぼると3月17日、7日で3月24日、3日で3月28日、1日で3月30日です。カレンダーに入れる前に、1行ずつ数え直してください。

そして、管理表の完成形は、次のようになります。

受注の出荷システム渡しAPIキー2026年4月1日2027年3月31日情報システムの担当共有フォルダの連携手順2027年3月1日
請求データの会計取り込みクライアントシークレット2026年7月1日2027年6月30日経理の責任者開発会社の保守手順書2027年5月31日
予定の同期リフレッシュトークン2026年10月1日6か月未使用で失効営業事務の担当担当メモ毎月の点検日

2行目は、7月1日に作って翌年の6月30日が期限なので、12か月に満たない設定です。Microsoftの資料が勧める「12か月未満」に沿った例です。3行目のように日付で切れないものは、「いつまで使われないと失効するか」を書き、点検の日を決めます。

注意 シークレットの値は、作成画面を閉じると再び表示されないサービスがあります。Microsoft Entra IDの資料でも、ページを終了すると値は再び表示されないと説明されています。値そのものは管理表に書かず、安全に保管する場所と、その場所の担当を書いてください。

期限の30日前から1日前まで、通知を5回に分けて並べた図

ステップ3 更新担当と手順書を決める

管理表には、更新担当を役割で書きます。個人の名前は、異動で古くなるからです。ただし、担当者が複数の連携を持つと、期限が重なった月に作業が集中します。管理表を期限の順に並べ替えて、同じ月に3本以上が重なるときは、事前に前倒しできるかを検討してください。

更新の手順書には、最低限、次の5つを書きます。

  • 新しい資格情報を発行する画面の場所と、必要な権限
  • 新しい値を設定する先(連携のプログラム、設定ファイル、連携サービスの画面)
  • 設定した後の確認方法(テストの実行、実データ1件の流れの確認)
  • 古い値を無効にする手順と、そのタイミング
  • 失敗したときの戻し方と、連絡先

手順書は、発注側の担当者が読める言葉で書いてもらいます。開発会社の技術者だけが読める手順書だと、担当者が替わったときや、会社を替えたときに、更新できなくなります。

もう1つ、更新の頻度を決める考え方があります。Diditの資料では、キーの入れ替えは30〜90日ごとが理想とされ、重要度の低い連携なら6か月でも許容される場合があるとされています。ただし、更新が多いほど、更新作業の失敗で止まる機会も増えます。止まったときの影響が大きい連携は、更新の回数を増やすより、更新の手順書と事前のテストを厚くするほうが安全な場合があります。回数は、提供元の決まりと自社の運用の負担を合わせて決めてください。

ステップ4 止めずに差し替える手順

差し替えの方法は、大きく2つに分かれます。どちらかで、止まる時間が大きく変わります。

新しい鍵を別に作る作業が終わるまで古い鍵も使えるほぼなし昼間でも作業できる
同じ鍵を再生成する再生成した瞬間に古い鍵が無効切り替えの間は止まる夜間・休日に作業する

ある配信ツールの公式資料では、新しいキーを作る方式では、古いキーはアーカイブするまで機能し続け、全部の連携が新しいキーへ移ってからアーカイブするよう案内されています。一方、再生成の方式では、古いキーは直ちに無効になり、新しいキーを設定した後にテストのリクエストを送って、拒否の応答(401)が出ないことを確認するとされています。

つまり、どちらの方式かによって、作業の時間帯と段取りが変わります。再生成の方式しか選べないサービスなら、注文が少ない時間帯に作業を入れ、その間に溜まるデータを後で流し直す準備をしておきます。

新しい鍵を別に作れる場合の手順は、次のとおりです。AppMasterの解説にある「オーバーラップモデル」(新旧を一定期間併用する考え方)に沿っています。

  • 新しい鍵を作って有効にする
  • 古い鍵は有効のままにして、更新中であることが分かるよう印を付ける
  • 連携の設定を新しい鍵に替えて、実際に1件流れることを確認する
  • 全部の連携が替わったことを確認してから、古い鍵を無効にする
  • 管理表の作成日・期限・次の通知日を書き換える

最後の1つが、よく抜けます。鍵を替えたのに管理表が古いままだと、次の年に、すでに無効な日付で警告が出て、現場が混乱します。更新の手順書の最後の行に、「管理表の更新」を必ず入れてください。

補足 Diditの資料は、古い鍵と新しい鍵の両方が有効な猶予期間を設けるよう勧めています。AppMasterの解説は、猶予期間を「まもなく期限切れ」のような曖昧な表現にせず、日時を具体的に示すよう勧めています。社内向けの通知でも、同じ書き方が役立ちます。

新しい鍵を作ってから古い鍵を無効にするまでの順番

3. 担当者が替わるときの引き継ぎ

資格情報の更新が止まる原因として、期限の次に多いのが、担当者の異動と退職です。引き継ぎの表に、次の項目を加えてください。

紐づくアカウント連携が退職者の個人アカウントで動いていないか情報システムの担当
鍵の保管場所値を知る人が退職者だけになっていないか責任者
通知の宛先期限の通知が退職者のメールに届いていないか責任者
鍵の作り直し鍵にアクセスできた人が離れたので作り直すか責任者と開発会社

先ほどの配信ツールの公式資料では、キーにアクセスできる人がチームやベンダーを離れたときに、キーを作り直すよう勧めています。つまり、退職する人が使っていた鍵は、引き継ぎだけで済ませず、作り直しも検討する対象です。ここで、期限の前でも更新の作業が発生するため、管理表の「作成日」と「期限」が変わります。

また、通知の宛先を個人にしないことも大切です。部署の共有メールアドレスを宛先にして、複数人が受け取るようにしてください。個人宛てにすると、その人が休暇中や異動後に、期限の通知を誰も読まなくなります。

4. 開発会社に確認しておくこと

連携を開発会社に作ってもらった場合は、契約や保守の打ち合わせで、次の質問をしておくと、後から困りにくくなります。

  • この連携が使う資格情報は何種類あり、それぞれの期限はいつか
  • 期限の何日前に、誰が、どの方法で知らせてくれるか
  • 更新作業は保守契約に含まれるか。別料金なら、1回あたりの費用の目安はいくらか
  • 更新の依頼から作業完了まで、通常は何営業日かかるか
  • 資格情報を発行した管理画面のアカウントは、誰の名義か
  • 古い鍵と新しい鍵を併用できるか。できない場合、作業中の停止時間はどのくらいか

特に、5つめの「アカウントの名義」は重要です。開発会社の担当者の個人アカウントで発行されていると、その担当者が会社を離れたときに、更新ができなくなるおそれがあります。ドメインやサーバーの名義の確認と同じで、発注側の会社の名義、または発注側が管理できるアカウントで発行してもらうよう依頼してください。

回答は、メールなどの文書で残してもらい、管理表の「手順書の場所」の欄に書きます。口頭だけの回答は、担当者が替わると消えてしまいます。

5. 期限切れでよくある失敗と先に打つ手

最後に、実際に起きやすい失敗を表にまとめます。どれも、ここまでの管理表と手順書で防げるものです。

試験運用のまま本番で使い、1週間で止まったテスト状態の認証は期限が短いことがある本番に移す前に、公開状態と期限を提供元の資料で確認する
長期休暇明けに連携が止まっていた使われない期間が長く、失効した使われない期間で失効する連携は、月1回の点検日に動作を確認する
更新したのに、翌日にまた止まった複数の連携が同じ鍵を使っていて、一部を替え忘れた鍵ごとに、使っている連携を管理表の1列に書く
再生成したら、すぐに連携が止まった古い鍵が直ちに無効になる方式だった作業前に方式を確認し、夜間に作業を入れる
期限の通知を誰も見ていなかった通知の宛先が退職者の個人メールだった宛先を部署の共有アドレスにする

どの失敗も、担当者の注意力の問題ではなく、決まりと表がなかったために起きています。期限を「人の記憶」に置かず、表とカレンダーに置くことが、いちばん確実な対策です。

小さな会社では、管理表を作る手間が負担に見えるかもしれません。連携が3本から5本程度なら、表は10行に収まり、作るのに半日もかかりません。止まったときに現場で手入力を巻き取る手間と比べると、先に表を作るほうが軽く済みます。

また、期限の1回めの通知日(30日前)に、「更新の作業日を決める」ことを入れておくと、期限ぎりぎりに作業が重なるのを避けられます。作業日は、注文や問い合わせが少ない曜日と時間帯に置き、同じ月に複数の連携が重なるときは、日を分けてください。更新の作業が終わったら、その連携について「更新済み」と「次の期限」を管理表に書き、通知の予約も組み直します。

まとめ

連携の期限切れは、洗い出し、期限と通知日の管理表、更新担当と手順書、止めない差し替えの4つで防げます。期限は日付のほかに、使われなかった期間やテスト状態、人の出入りでも訪れます。管理表には、期限の30日前から1日前まで複数回の通知日を書き、鍵の値そのものは書かずに保管場所を書いてください。

連携の洗い出しや、管理表に書く期限の確認で手が止まったときは、使っているサービスの一覧をもとに一緒に確認することもできます。

よくある質問

APIキーには、必ず有効期限があるのですか。

サービスによって違います。期限のないキーもあれば、Microsoft Entra IDのクライアントシークレットのように24か月以内と決まっているものもあります。まず、使っている連携ごとに、資格情報の種類と期限の有無を提供元の資料で確かめてください。

期限が切れる日は、どこで確認できますか。

資格情報を発行した管理画面の一覧に、有効期限が出ているサービスが多くあります。画面に出ないものは、提供元の公式資料で期間を確かめ、発行した日から計算して管理表に書いておきます。

キーを再発行すると、古いキーはどうなりますか。

サービスによって異なります。ある配信ツールの公式資料では、再生成すると古いキーは直ちに無効になると説明されています。一方、新しいキーを別に作る方式では、古いキーをアーカイブするまで動き続けます。更新の前に、どちらの方式かを確認してください。

更新作業は開発会社に任せきりでもよいですか。

作業は任せても、期限の把握と更新の依頼は発注側の仕事にしておくと安全です。保守契約に更新作業が含まれているか、費用が別か、依頼から作業まで何営業日かを、契約前に確認してください。

参照元・出典

FREE CONSULTATION

「うちの場合はどうか」から

記事の考え方を、そのままご自身の事業に当ててみたい方へ。アイデア段階でも、機能リストがある段階でも構いません。 2営業日以内に、担当者からメールでご返信します。営業のお電話はしません。相談は無料です。

運営:株式会社miitaso(会社概要)

RELATED