Skip to content

5.4 API の提供を終了する

5.4 API の提供を終了する

API を終了する場合、特に広く一般に公開された API の提供を終了する場合には、事前に終了日時をアナウンスし、利用者にそれまでに対応するように周知徹底をする。

5.4.1 ケーススタディ: Twitter の場合

バージョン 1.0 の廃止、1.1 への移行

Blackout Test

一時的に終了する API を停止してアクセスできないようにするテスト。

「継続的な告知」や「Blackout Test」を行い周知徹底を行っていた。

5.4.2 あらかじめ提供終了時の仕様を盛り込んでおく

API のドキュメントに提供終了後の仕様を記載する。以下は一例。

  • 公開終了後はステータスコード 410(Gone) を返す
  • エラーメッセージとして API が公開終了していること、新しい API を利用すること等を記載する

自社のモバイルアプリ向け API の場合はアプリ側にも提供終了後の仕様を追加しておく。
(強制アップデート等)

5.4.3 利用規約にサポート期限を明記する

利用規約に古いバージョンをどのくらいの期間サポートをするのかという最低限の期間を定めておく。
→サービスの「保障」と「提供範囲の明確化」を行う