Salesforce APIバージョンとは？APIの概要とAPIバージョン情報をご紹介

Salesforce APIとは？

APIは、システム間やシステム内で仲介的に通信を行うときに必要な規定のことです。規定どおりの方法でアクセスすることにより、規定どおりの結果を返してくれるのがAPIの働きです。 APIは検索用としても取り入れられています。例えば、検索API経由で定められたとおりに検索ボタンをクリックして、諸条件を入力、検索してみると、探していた答えが表示されるという結果が得られます。APIの機能により、検索サイトで検索したときと同じ結果を得られるのです。 SalesforceでもAPIの機能が数多く使われています。APIの機能によって、安全で、柔軟な使い方のできるユーザーインターフェースの設計やデータの操作が可能になります。

さまざまな種類のSalesforce API

Salesforce APIにはさまざまな種類があるため、ユーザーのニーズに最適なAPIを選択できます。また、SalesforceのAPIバージョンは、何度もバージョンアップされ、機能が高まり続けています。 よく使われるSalesforce APIの種類としては、REST API、SOAP API、Bulk API、ストリーミングAPI、Chatter Rest APIなどが挙げられます。これらのAPIを駆使することにより、Salesforceでのデータの操作が可能になります。 以下ではいくつかのAPIの特徴とAPIバージョンに関する情報を紹介していきます。

SOAP API

SOAP APIは、Spring’12以前はWeb Service APIという名称で、これまでAPIバージョンの更新が何度も行われてきました。標準的な機能を持ち、多数のAPIコールが装備されているので、サーバ同士の統合の構築に最適です。

Bulk API

Bulk APIは、大量のレコードの一括削除に最適なAPIです。処理にも時間がかからず、APIコール数を抑制することができます。 現在、Bulk APIには1.0と2.0の、2つのAPIバージョンがあります。どちらも大量のデータ処理が可能です。

ストリーミングAPI

ストリーミングAPIは、Salesforceのユーザーのニーズに合わせたAPIの選択をするのに最適です。サーバからユーザーへのデータ更新の通知やWeb画面の埋め込みなどに適しています。 APIバージョンによっては、古いバージョンで登録している場合、メッセージを受信できないことがあるので最新バージョンに更新しておくことをお勧めします。

APIバージョンとは？

SalesforceのAPIは常に更新されているので、使用可能なメソッドとパラメータはバージョンによって異なります。スムーズな開発を行うためにも、使用前にAPIバージョンの確認が勧められています。 Salesforceのバージョン自体もその年の季節ごとに更新されていますが、それに対応してAPIバージョンも更新される場合があります。また、バージョンを廃止した場合は、終了バージョンは使用不可になり、サポートもなくなります。 サポートされていないバージョンを使うとエラーが発生することになるのでSalesforce HP内での確認をお勧めします。

APIバージョンの設定方法

クラスまたはトリガにSalesforceのAPIバージョンを設定する手順を以下に紹介します。 1. クラスまたはトリガの編集画面からVersion Settings（バージョン設定）をクリック 2. Salesforce APIのバージョンを選択 3. 保存をクリック

使用可能なバージョンの確認方法

使用中のSalesforce APIバージョンで行うことのできる3種類の確認方法を以下に紹介します。尚、APIアクセスが可能なエディションにおいてのみ適用される手順となります。

Salesforce Classic ユーザインターフェースの場合

Salesforce Classic ユーザインターフェースの場合の手順です。 1. 「設定」にアクセス 2. クイック検索ボックスに「API」と入力 3. 「開発」の下の「API」をクリック 4. 「Enterprise WSDLの生成」をクリック 5. 次ページ「Installed Package」一覧中の「Generate」ボタンをクリック 6. 利用中のAPIバージョンが表示される

Lightning Experience ユーザインターフェースの場合

Lightning Experience ユーザインターフェースの場合の手順です。 1～3まではSalesforce Classicと同じ手順で進みます。 4. 「Enterprise WSDLの生成」をクリック 5. 「Generate」をクリック 6. 利用中のAPIバージョンが表示される

Salesforce Classic と Lightning Experience の場合

「設定」にアクセス後、クイック検索ボックスに「Apexクラス」と入力し、選択します。「新規」をクリック後、「Version Settings」をクリックするとバージョン列の最上部にバージョンの値が表示されます。

APIバージョン廃止で必要になる作業

次にAPIバージョンを変更するために必要な作業を紹介します。Flow Builderにてフローを開いた後、フローバージョンのプロパティを編集します。 また、プロセス実行時のAPIバージョンの変更は、プロセスビルダーでプロセスを開いた後、プロパティを編集することで変更が可能になります。

Salesforce APIバージョンについて知っておこう

Salesforce APIバージョンを確認しておくことで、エラーの発生を防ぎ、スムーズに最新のバージョンを更新して業務を行うことが可能になります。 Salesforceからの通知やHPの最新情報を確認して、常にバージョン管理を行いましょう。]]>