SOAP API の概要

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 にアップグレードする場合は、担当者にご連絡ください。

Web サービスクライアントアプリケーションを開発するには、Developer Sandbox を使用することをお勧めします。Developer Sandbox はすべてのカスタマイズやデータを含む、Salesforce リリースの完全なレプリカです。詳細は、「Sandbox からの機能強化のリリース」を参照してください。

Developer Edition では、Enterprise Edition で使用できるすべての機能にアクセスできます。Developer Edition で制約されているのは、ユーザ数とディスク容量のみです。Developer Edition では、組織の使用中のデータに影響を与えることなくソリューションを構築およびテストできる開発コンテキストを用意しています。Developer Edition のアカウントは、https://developer.salesforce.com/gettingstarted から無料で入手できます。

SOAP API は、次の標準���様に準拠するよう実装されています。

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」にアクセスしてください。

クライアントアプリケーションでは、より豊富な機能と優れた効率性の利点を十分に生かすよう、最新バージョンの Lightning Platform WSDL ファイルを使用することをお勧めします。組織の最新の WSDL に移動するには、[設定] から、[クイック検索] ボックスに「API」と入力し、[API] を選択します。新しいバージョンがリリースされた場合は、クイックスタートで次の手順を実行してご使用の WSDL を更新してください。

• WSDL ファイルを再生成する (「ステップ 2: Web サービス WSDL を生成または取得する」)
• WSDL ファイルをご使用の環境にインポートする (「ステップ 3: 開発プラットフォームに WSDL ファイルをインポートする」)

Salesforce は、各 API バー���ョンを最初のリリース日から最低 3 年間サポートします。API の品質およびパフォーマンスを充実させ、改善するために、3 年を超えるバージョンのサポートは停止される場合があります。

API バージョンに廃止の予定がある場合、サポートが終了する最低 1 年前までに事前通知されます。Salesforce は、廃止予定の API バージョンを使用するお客様に直接通知します。

廃止された API バージョンからリソースを要求したり、操作を使用したりすると、SOAP API から 500:UNSUPPORTED_API_VERSION エラーコードが返されます。

古いまたはサポートされない API バージョンの SOAP API から出された要求を識別するには、無料の API 合計使用量イベント種別にアクセスします。

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 を使用して、組織内のデータにアクセスすることができます。

Salesforce 開発者 Web サイトでは、開発者ツールキット、サンプルコード、サンプル SOAP メッセージ、コミュニティベースのサポート、およびその他のリソースの完全パッケージを提供して、開発プロジェクトを支援します。詳細は、developer.salesforce.com を参照してください。developer.salesforce.com/signup からは、Developer Edition のアカウントを無料で取得できます。

以下の Web サイトにアクセスすると、Salesforce アプリケーションの詳細情報を入手できます。

• Salesforce では、Salesforce アプリケーションの詳細情報が提供されています。
• Salesforce AppExchange では、Salesforce 向けに作成されたアプリケーションにアクセスできます。
• Trailblazer Community では、Salesforce のお客様の成功を実現するサービスが提供されています。