APIバージョンを定期的に更新しましょう

特に重要な情報

運用

2022.06.23

Share:

この記事で学べること

  • APIバージョンを定期的に更新することの重要性
  • APIバージョンのサポート対象期間

APIとは

API(Application Programing Interfaceの略)は、外部システムから自システムに対するリクエストを受け取るために用意された窓口(インターフェース)です。

外部システムからSalesforceの情報にアクセスする必要がある時にはSalesforceのAPIを使用します。例えば、基幹システムの売上データをSalesforceに取り込む処理(夜間バッチなど)であったり、社内システムからのリクエストでSalesforceのデータを参照する時に使用します。

APIのバージョン

APIにはバージョンという概念があります。APIを使用するときは、以下のように宛先とバージョンを指定してアクセスをします。以下の例では、外部システムから、Salesforceに対してSOAP APIの54.0のバージョンでアクセスをしています。

上記例はSOAP APIですが、他にもいくつか種類があり、いずれも、バージョンを指定する必要があります。

※APIの種類については、Salesforce プラットフォーム API について知る(Trailhead)をご確認ください。

APIの最新バージョンは、Salesforce の年3回のバージョンアップのタイミングで更新されます。

Summer ’22: APIバージョン55.0 

Winter ’23:APIバージョン56.0

しかし、APIバージョンは外部システムによって明示的に指定されるため、お客様(外部システム)にて定期的に新しいバージョンに更新していただく必要があります。そして、Salesforceではあらかじめ最低限のサポート対象期間が決まっています。

APIのサポート対象期間

Salesforce は、API バージョンを最初のリリース日から最低 3 年間サポートします

API の品質およびパフォーマンスを充実させ、改善するために、3 年を超えるバージョンのサポートは停止される場合があります。API バージョン廃止の予定がある場合、サポートが終了する最低 1 年前までに事前通知されます。

※実際に廃止になった例は、Salesforce Platform API バージョン 7.0 ~ 20.0 の廃止(サクセスナビ)をご覧ください

APIをご利用の場合は、上記サポート期間を目安に定期的にAPIバージョンを更新いただくことを推奨します。

APIバージョンの更新

更新箇所の確認:

APIバージョンを更新する際は、まずはどこでAPIを使用しているかを把握している必要があります。

開発を外部発注した場合は、ベンダーから受け取った仕様書に、使用しているAPIバージョンの記載があることを確認し、大切に保管します。

社内で開発をする場合も、APIバージョンを含めた仕様を後で確認ができるように管理方法を決めて、社内で共有しておきましょう。

更新作業:

実際のAPIバージョン更新作業は、Salesforce以外のシステムの設定変更であったり、AJAX Toolkitを使用した開発をしている場合はデプロイが必要になります。そのため、通常はベンダーや開発者様にて実施いただく作業になります。

外部ベンダーへ依頼する場合には、社内プロセス(予算取りや承認申請など)に時間がかかることもあるかもしれませんので、早めに準備をしておきましょう。

その他:

データローダもAPIを使用します。

PCの画面上でデータローダを起動しご利用いただいている場合は、Salesforceの[設定]画面からデータローダのダウンロードをする事で、新しいAPIバージョンを使用する最新のデータローダを再インストールすることができます。

データローダのツール自体のサポートは最新バージョンのみとなりますが、少なくとも3年に1度はデータローダを再インストールすることをお勧めします。

学習ツール

まとめ

  • SalesforceのAPIバージョンは、年3回のバージョンアップで更新される
  • リリース日から3 年を超えるAPIバージョンのサポートは停止される場合があります
  • APIバージョン廃止の影響を防ぐため、定期的にお客様でのAPIバージョン更新作業を推奨します

運用

2022.06.23

Share:

前の記事「拡張ドメインの有効化とその準備」

Hot Topic

このカテゴリの人気記事

Salesforceについてもっと学ぶ

Salesforce活用に役立つメルマガ登録

システム管理者のみなさまにおすすめの活用ウェブセミナーや、Salesforceでビジネスを推進いただくために有益なコンテンツを毎月お届けします。

Follow us!

Twitter公式アカウント

Salesforce活用に役立つメルマガ登録(毎月配信)

  • 私は、個人情報保護基本方針プライバシーに関する声明個人情報利用についての通知に同意します。 特に、プライバシーに関する声明で定めるとおり、情報のホスティングと処理を目的として私の個人データをアメリカ合衆国を含む国外に転送することを許可します。詳細私は、海外では日本の法律と同等のデータ保護法が整備されていない可能性があることも理解しています。詳細はこちらでご確認ください

  • 私は、Salesforce の製品、サービス、イベントに関するマーケティング情報の受け取りを希望します。私は、当該マーケティング情報の受け取りを私がいつでも停止できることを理解しています。