SOAP API について
Salesforce では、使いやすく、強力で安全なアプリケーションプログラムインターフェースを使用した組織の情報へのプログラムによるアクセスを提供しています。SOAP API の詳細を理解するには、ソフトウェア開発、Web サービス、そして Salesforce ユーザーインターフェースについての基本的な知識が必要です。
このガイドで説明されている機能は、組織で API 機能が有効化されている場合に使用できます。この機能は、Performance Edition、Unlimited Edition、Enterprise Edition、Developer Edition ではデフォルトで有効になっています。Professional Edition を使用する組織の中には、API が有効化されている組織もあります。このガイドに記載されている機能にアクセスできない場合は、Salesforce にご連絡ください。
Salesforce では、SOAP API に加えていくつかの API を提供しています。SOAP API が使用に適しているかどうかについては、Salesforce ヘルプの「どの API を使用するか?」を参照してください。
Salesforce ソリューションのカスタマイズ、インテグレーション、および拡張
Lightning Platform を使用すると、選択した言語およびプラットフォームを使用して、ご使用の Salesforce 組織を次のようにカスタマイズ、インテグレーション、および拡張できます。
- Salesforce のカスタマイズ: カスタム項目、カスタムリンク、カスタムオブジェクト、カスタムページレイアウト、カスタムボタン、カスタムレコードタイプ、カスタム Sコントロール、カスタムタブを使用して、特定のビジネス要件を満たします。
- Salesforce のインテグレーション: 組織の ERP や会計システムを使用して統合します。リアルタイムの販売情報やサポート情報を会社のポータルに配信し、重要なビジネスシステムに顧客情報を入力します。
- Salesforce の拡張: 組織のビジネス要件を反映する新機能により、プレゼンテーション、ビジネスロジック、およびデータサービスの面で拡張します。
Lightning Platform ソリューションおよび開発者のリソースについての詳細は、「Salesforce Developers (Salesforce 開発者)」にアクセスしてください。
サポートされているエディションと必要な権限
SOAP API を使用するには、組織で Enterprise Edition、Performance Edition、Unlimited Edition、または Developer Edition を使用する必要があります。既存の Salesforce のお客様が Enterprise Edition、Unlimited Edition、または Performance Edition にアップグレードする場合は、担当者にご連絡ください。
本番組織の設定とライブデータを保護するために、すべてのソリューションおよび変更の作成およびテストには、Developer Edition、Sandbox、またはスクラッチ組織のような分離された環境を使用することをお勧めします。
Developer Edition では、Enterprise Edition で使用できるすべての機能へアクセスできますが、組織ごとのユーザー数とストレージ容量が制限されます。このリンクで、無料の Developer Edition にサインアップできます。Sandbox は、既存の組織のコピーを分離された環境に作成します。詳細は、「Sandbox: カスタマイズとテストのためのステージング環境」を参照してください。スクラッチ組織は、ソース駆動型で破棄可能なリリースであり、あらゆる設定が可能です。機能や設定の異なるさまざまな Salesforce エディションをエミュレートできます。詳細は、「スクラッチ組織」を参照してください。
サポートされている全エディションで、ユーザーが割り当てら��ているユーザープロファイルの「API の有効化」権限が有効になっている必要があります。この権限は、一部のプロファイルではデフォルトで有効になっています。たとえば、Developer Edition 組織にある多くのプロファイルで有効になっています。また、サポートされているエディションでは、Salesforce インテグレーションユーザーライセンスを使用して、システム間インテグレーションユーザーに組織へのアクセス権を与えながら、操作は API のみに制限することができます。詳細は、Salesforce ヘルプの「インテグレーションユーザーへの API 限定アクセス権の付与」を参照してください。
標準への準拠
SOAP API は、次の標準仕様に準拠するよう実装されています。
| 標準名 | Web サイト |
|---|---|
| Simple Object Access Protocol (SOAP) 1.1 | https://www.w3.org/TR/2000/NOTE-SOAP-20000508/ |
| Web Service Description Language (WSDL) 1.1 | http://www.w3.org/TR/2001/NOTE-wsdl-20010315 |
| WS-I Basic Profile 1.1 | http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html |
開発プラットフォーム
SOAP API は、Visual Studio .NET 2005 を含む、現在のさまざまな SOAP 開発環境で動作します。本ドキュメントでは、Java および C# (.NET) の例を示しています。Java の例は WSC 20.0 (WSC) および JDK 6 (Java Platform Standard Edition Development Kit 6) に基づいています。他のバージョンの WSC は、https://github.com/forcedotcom/wsc および https://mvnrepository.com/artifact/com.force.api/force-wsc で入手できます。互換性のある開発プラットフォームの詳細やさらなるサンプルコードについては、「developer.salesforce.com」にアクセスしてください。
SOAP API サポートポリシー
クライアントアプリケーションでは、より豊富な機能と優れた効率性の利点を十分に生かすよう、最新バージョンの Lightning Platform WSDL ファイルを使用することをお勧めします。組織の最新の WSDL に移動するには、[設定] から、[クイック検索] ボックスに「API」と入力し、[API] を選択します。新しいバージョンがリリースされた場合は、クイックスタートで次の手順を実行してご使用の WSDL を更新してください。
- WSDL ファイルを再生成する (「ステップ 2: Web サービス WSDL を生成または取得する」)
- WSDL ファイルをご使用の環境にインポートする (「ステップ 3: 開発プラットフォームに WSDL ファイルをインポートする」)
後方互換性
Salesforce は、Lightning プラットフォームを使用する場合の後方互換性を容易に維持できるよう努めています。
新しい Salesforce リリースは、次の 2 つのコンポーネントで構成されています。
- Salesforce システムにある新しいリリースのプラットフォームソフトウェア
- 新しいバージョンの SOAP API
たとえば、Winter '07 リリースには SOAP API バージョン 9.0 が、Summer '07 リリースには SOAP API バージョン 10.0 が含まれていました。
プラットフォームソフトウェアのリリース全体で、各 SOAP API バージョンのサポートを維持しています。指定した SOAP API バージョンで機能するよう作成されたアプリケーションが、その後のプラットフォームソフトウェアのリリースでも同じバージョンの SOAP API では継続して機能するという点では、SOAP API には後方互換性があります。
Salesforce では、あるバージョンの SOAP API に対応して作成されたアプリケーションがその後の SOAP API バージョンで機能することは保証されません。SOAP API の拡張は継続して行われているため、メソッド署名��よびデータ表示の変更が必要になる場合がよくあります。ただし、変更によりアプリケーションを新しい SOAP API バージョンに移行する必要がある場合、バージョン間の SOAP API の一貫性を最小限に保持しています。
Winter '07 リリースに付属する SOAP API バージョン 9.0 を使用して作成されたアプリケーションは、Summer '07 リリースの SOAP API バージョン 9.0、また今後のリリースにも引き続き対応します。ただし、同じアプリケーションが SOAP API バージョン 10 で機能するようにするために、アプリケーションを変更する必要がある場合があります。
WSDL の選択
API アクセスの WSDL ファイルを取得できる Lightning Platform Web サービスは、次の 2 つです。
-
Lightning Platform Enterprise WSDL — この API は、組織のクライアントアプリケーションを開発する多くのエンタープライズユーザー向けのものです。Enterprise WSDL ファイルは、組織データを強力に定型化して表示されます。開発環境にスキーマ、データ型、項目に関する情報を提供し、開発環境と Lightning Platform Web サービスとのより緊密なインテグレーションを実現できます。この WSDL は、組織の Salesforce 構成でカスタム項目またはカスタムオブジェクトが追加、名前変更、または削除された場合に変更されます。Enterprise WSDL をダウンロードし、管理パッケージを組織にインストールする場合、生成された WSDL に追加するインストールパッケージのバージョンを選択するという、追加のステップを実行する必要があります。Enterprise WSDL を生成する場合は、次の点に注意してください。
- 組織の情報に対して新しいカスタム項目またはカスタムオブジェクトが追加、名前変更または削除された場合、WSDL ファイルを再生成して項目やオブジェクトにアクセスする必要があります。
- 生成された WSDL には、選択されたバージョンの各インストールパッケージで使用できるものなど、組織内のオブジェクトや項目が含まれています。項目またはオブジェクトが今後のパッケージバージョンに追加される場合、API インテグレーションのオブジェクトまたは項目と連動するよう、そのパッケージバージョンで Enterprise WSDL を生成する必要があります。
- Lightning Platform Partner WSDL — この API は、複数の組織のクライアントアプリケーションを開発する Salesforce パートナー向けのものです。Salesforce オブジェクトモデルはあまり強く型付けされていないため、この Partner WSDL を使用して、組織内のデータにアクセスすることができます。