マネーフォワード クラウドのAPI変更ポリシー
本ドキュメントは、マネーフォワード クラウドの公開APIを対象とした、変更方針を定めたポリシーです。
当社は本ポリシーに定められた事項を保証または遵守する義務を負うものではなく、法改正、技術上の理由、当社の経営判断、 その他の事情により本ポリシーは変更されまたは本ポリシーと異なった運用がされる場合があります。
本ポリシーの適用対象
- パートナーを含む一般の顧客に公開されたマネーフォワード クラウドのAPIが対象です。
- ベータ版APIは本ポリシーの適用範囲外です。
バージョニング
- APIバージョンはエンドポイントURLに含まれます。例:
/v1/... - 破壊的変更がある場合のみメジャーバージョンを上げます。非破壊的変更は同一メジャーバージョンで提供します。
破壊的変更と非破壊的変更
破壊的変更
変更が後方互換性を持たず、既存のAPI利用者が変更を必要とする場合、それは破壊的変更です。
破壊的変更の例:
- 必須項目の追加
- 型や構造の変更
- 動作の変更
- HTTPステータスの変更
- キーの削除/リネーム
- など
非破壊的変更
変更が後方互換性を持ち、既存のAPI利用者が変更を必要としない場合、それは非破壊的変更とします。
非破壊的変更の例:
- 既定値つきのオプション項目の追加
- レスポンスへのキーの追加
- 許容範囲や文字長の拡張
- 並び順の変更
- など
非推奨・廃止
- 旧バージョンの廃止は、当社が指定する相当期間前に告知します。
- 告知時点で移行先バージョンを提供し、一定期間は旧版と併存します。
- 廃止の通知は、サポートサイト、APIリファレンス、レスポンスヘッダー(Deprecation/Sunset)、メールなどで行われます。
緊急時の対応について
- 法令や規制対応、重大なセキュリティ脆弱性への緊急対応、システム安定維持のための緊急メンテナンスその他やむを得ない事情により、APIを予告なく変更や提供終了とする場合があります。その場合、可能な限り速やかに、サポートサイトに記載するなどの適切な方法でお知らせします。
マイグレーション
- 新バージョンのリリース時は、可能な限り移行手順を提供します。
サポート
- 非推奨期間中は旧版を継続提供しますが、サポート内容は限定される場合があります。