Moneytree LINK API バージョン

APIのバージョンアップについて

Moneytree LINK APIはバージョン管理されています。各APIバージョンは後方互換であるため、新しいAPIバージョンにアップグレードして新しい機能を採用することを選択するまで、お客様のアプリケーションは同じ、安定したバージョンのAPIを使用することができます。

新しいAPIバージョンを導入するのは、後方互換性のない変更を行う必要がある場合のみです。新しいAPIバージョンは、機能性、使いやすさ、パフォーマンスを向上させます。

Moneytree LINK APIのバージョンは、APIバージョンのリリース日に対応しています。例えば、APIバージョン2023-04-26は、2023年4月26日(水)にリリースされました。

APIバージョンの指定方法

Moneytree LINK APIへのリクエストでは、HTTPヘッダ Moneytree-API-Version に希望のバージョンを設定してください。

以下の例では、APIバージョン 2023-07-03 でユーザープロファイル情報をリクエストしています。

curl 'https://jp-api-staging.getmoneytree.com/link/profile.json' \
  -H 'authorization: Bearer TOKEN' \
  -H 'Moneytree-API-Version: 2023-07-03'  

HTTPヘッダーの Moneytree-API-Version にバージョンを指定しない場合、リクエストには デフォルトのAPIバージョン が使用されます。Moneytree LINK API へのすべてのリクエストに対して、同じ Moneytree-API-Version HTTP ヘッダを設定することを推奨します。

存在しないAPIバージョンを指定した場合、リクエストは無効とみなされ、HTTP 400レスポンスが返されます。

また、各APIレスポンスには、受け取ったバージョンを示すHTTPヘッダー Moneytree-Api-Version があります。

APIバージョンに対応したドキュメンテーション

Moneytree LINKのドキュメントにもバージョン表記があります。このページの左上でAPIバージョンを選択することができます。ドキュメント、Recipes、API仕様書などは、すべてそのAPIバージョンに対応したものです。

デフォルトのAPIバージョン

デフォルトのAPIバージョンは、お客様のオンボーディング時に利用可能な最新バージョンです。

HTTPヘッダを含めない場合、Moneytree LINK APIはデフォルトのAPIバージョンを提供します。

📘

後方互換性

既存のクライアントアプリケーションに対して、Moneytree-API-Version HTTPヘッダーを設定する必要はありません。アプリケーションは、以前使用していたのと同じAPIバージョンを引き続き使用することになります。

APIバージョンライフサイクルポリシー

新しいAPIバージョンがリリースされる際、旧APIバージョンのEOS（End-of-Support）日をお知らせします。旧APIバージョンのサポート期間は24か月間です。

EOSの日付に達すると、旧APIバージョンの機能を保証することはできず、新しいバージョンへの移行を支援する以外のサポートは提供されなくなります。

チェンジログ

利用可能なすべてのAPIバージョンは、Changelogで確認できます。これにより、変更点を理解し、新しいAPIバージョンにアップグレードする方法を案内します。