Salesforceは、他のシステムやサービスとデータをやり取りするために「API(Application Programming Interface)」を提供しています。APIを使うことで、Salesforceのデータを外部システムから取得したり、外部システムにデータを送信したりできます。
APIとは?
API(エーピーアイ)とは、「アプリケーション同士をつなぐインターフェース」のことです。例えば、あるアプリからSalesforceにある顧客情報を取得したいとき、APIを使えばその情報をプログラムで簡単にやり取りできます。
インターフェースとは?
インターフェースとは、異なるシステムやソフトウェアが「どのようにやり取りするか」を定めた仕組みのことです。人間で言えば「共通言語」のようなもので、APIはこの共通言語を使ってSalesforceと外部アプリをつなげます。たとえば、スマホのアプリがボタンを押すとカメラが起動するのも、アプリとカメラの間でインターフェースが定義されているからです。 API(エーピーアイ)とは、「アプリケーション同士をつなぐインターフェース」のことです。例えば、あるアプリからSalesforceにある顧客情報を取得したいとき、APIを使えばその情報をプログラムで簡単にやり取りできます。
Salesforceで使える主なAPIの種類
Salesforceでは、目的に応じていくつかのAPIが用意されています。
REST API
REST(レスト)APIは、HTTP通信を使ってSalesforceとデータのやり取りを行うAPIです。シンプルな構造で、初心者でも扱いやすいのが特徴です。
- 使用例:取引先情報の取得、レコードの新規作成、更新、削除など
- データ形式:JSON(ジェイソン)という軽量なデータフォーマット
SOAP API
SOAP(ソープ)APIは、XMLという形式でデータをやり取りするAPIです。RESTよりも構造が厳密で、企業システムとの連携に使われることが多いです。
- 使用例:バッチ処理や、複雑なビジネスロジックを含むシステム連携
- データ形式:XML(エックスエムエル)
Bulk API
大量のデータを一括で挿入・更新・削除するためのAPIです。RESTやSOAPよりも高速に大量データを扱えるのが特徴です。
- 使用例:数千件〜数百万件のデータインポート・エクスポート
APIバージョンについて
SalesforceのAPIには「バージョン」が存在し、定期的に新しいバージョンがリリースされます。バージョンによって使用できる機能や仕様が異なるため、適切なバージョンを選ぶことが重要です。
バージョンの指定方法
APIリクエストのURL内で「vXX.0」という形式でバージョンを指定します。たとえば、バージョン59.0を使用する場合は以下のようになります:
https://yourInstance.salesforce.com/services/data/v59.0/sobjects/Account
バージョン選定のポイント
- 最新バージョンを使うと、新機能が利用可能です。
- ただし、既存の実装と互換性が合わない場合があるため、開発中に十分なテストが必要です。
- 実際の利用環境に合わせて安定したバージョンを選ぶのが安全です。
APIバージョン一覧はSalesforce公式ドキュメントで確認できます。
Salesforce API バージョン一覧(リリースノート)はこちら
API接続に必要な準備
SalesforceとAPIで接続するためには、いくつかの準備が必要です。
接続アプリケーションの登録(Connected App)
API接続を行うには、Salesforce上に「Connected App(コネクテッド・アプリ)」を作成する必要があります。これにより、外部アプリがSalesforceにアクセスするための「認証情報(クライアントIDやクライアントシークレット)」が発行されます。
認証(OAuth)
Salesforceでは「OAuth(オーオース)」という認証方式を使って、外部アプリのアクセスを安全に管理します。OAuthでは、トークン(鍵のようなもの)を発行し、それを使ってAPIを利用します。
- アクセストークン:一時的に有効な認証情報で、これを使ってAPIにアクセスします。
- リフレッシュトークン:アクセストークンが切れた後に新しいトークンを取得するために使います。
実際にAPIを使ってみよう(REST APIの例)
ここでは、Postman(ポストマン)というAPIテストツールを使って、Salesforceに接続する例を紹介します。
ステップ1:Postmanのインストール
Postmanは、APIを簡単にテストできる無料ツールです。公式サイトからダウンロードしてインストールしましょう。
ステップ2:アクセストークンの取得
事前に作成したConnected Appの情報を使って、OAuth認証を行い、アクセストークンを取得します。
ステップ3:APIリクエストの送信
アクセストークンを使って、例えば以下のようなGETリクエストを送ると、Salesforceのデータが取得できます。
GET https://yourInstance.salesforce.com/services/data/vXX.0/sobjects/Account
Authorization: Bearer アクセストークン
おわりに
SalesforceのAPI接続は、一見難しそうに見えますが、仕組みを理解してステップごとに進めれば初心者でも扱えるようになります。今回紹介したREST APIを使えば、Salesforceとの連携がグッと身近になります。