kintone APIのアップデートおよび提供に関する方針

はじめに

本稿では、kintone API(以下、API)のアップデートおよび提供に関する方針を記載しています。
APIのアップデートとは、本サイトのAPIドキュメントに記載されているAPIの仕様の変更や削除、APIの新規追加を指します。
合わせて、APIのアップデートに際して事前に告知される情報や、アップデートに伴う移行対応を支援する機能「アップデートオプション」の活用についても説明します。
APIを利用したプログラムの開発や運用に携わる皆様が、APIのアップデートに伴う対応の見通しを立てやすくなり、より安定したサービス提供に活用していただくことを目的としています。

APIアップデートの基本方針

kintoneでは、よりよいサービスを提供するため、継続的にプロダクトのアップデートを行っています。
APIにおいては、APIの互換性に留意してアップデートを行います。
ただし、製品の改善やセキュリティ上のリスク低減等のために必要と判断した際など、既存APIの仕様変更や廃止を伴うアップデートを行う場合があります。

アップデート内容の事前告知

kintoneでは、毎月第2日曜に定期メンテナンスを実施します。
定期メンテナンス時にAPIアップデートを月例チャネルへリリースする際は、定期メンテナンスの4週間前までに、次のページにて告知します。
APIアップデート情報​

アップデートに伴う対応コストが大きい等、一定の準備期間が必要と見込まれるアップデートについては、より早期に告知します。
ただし、緊急性の高い脆弱性や不具合の改修時など、やむを得ず事前告知を実施しない場合があります。
また、アップデートオプション(詳細は後述)により、APIアップデートをデフォルト無効の状態で提供する際は、提供開始にあたっての事前告知は行いません。

アップデートオプション機能の利用

APIアップデートの内容(互換性、変更範囲など)に応じて、アップデートオプションの対象とする場合があります。
アップデートオプションとは、アップデートの有効/無効を切り替えられる機能です。
kintoneでは、この機能を活用し、リリース予定の新機能の動作確認や、リリース後の新機能を無効化してリリース前の状態を再現できます。
アップデートオプションの詳細は、次のヘルプページを確認してください。​
[アップデートオプション]画面でできること (External link)

リリース予定の新機能の先行利用

実装検証やプログラム改修等、事前準備の必要性が高いと見込まれるAPIアップデートは、アップデートオプション「リリース予定の新機能の先行利用」の対象とします。

対象のアップデートは、リリースに先立って動作させることができます。
このオプションを活用することで、APIを利用するプログラムの、事前の動作確認や改修が可能です。
先行利用の対象とする際は、APIの仕様および期間等の詳細を、次のページで告知します。
APIアップデート情報

先行利用の期間は、前の仕様に基づくAPIの呼び出しが引き続き動作するか等に留意して都度調整します。
また、期間中に、追加でご案内すべき事項が生じた場合には、同ページにて速やかにお知らせします。

新機能の無効化

APIアップデートを、アップデートオプション「新機能の無効化」の対象とする場合があります。
対象のアップデートは、リリース後に一時的に無効化できます。
このオプションを活用することで、たとえばAPIアップデートに起因するプログラムの変化がリリース後に判明した場合などに、一時的に問題を回避したり、プログラムの改修期間を追加で確保したりできます。
原則として、3ヵ月以上の無効化可能な期間を設けます。