Connect REST API はじめに | Connect REST API 開発者ガイド

Connect REST API を使用するケース
Connect REST API は自身にとって適切な API か?

Connect REST API アーキテクチャ
Connect REST API を使用するには、認証方法やサポートされるデータ形式など、そのアーキテクチャの特性をいくつか理解する必要があります。

Connect REST API の制限
Connect REST API 要求はレート制限の対象になります。Connect REST API には、他の Salesforce API とは異なるレート制限があります。Connect REST API には、ユーザー、アプリケーション、および時間ごとのレート制限があります。レート制限を超過すると、すべての Connect REST API リソースが 503 Service Unavailable エラーコードを返します。

リソース URL の作成
Connect REST API リソースへのアクセスには、会社のインスタンスの URI に、バージョンと Experience Cloud サイト情報、およびリソースの URI を組み合わせて使用します。

HTTP 要求の送信
Connect REST API は HTTP メソッドを使用して JSON および XML コンテンツを送受信します。そのため、自分で選んだツールや言語を使用してクライアントアプリケーションを簡単に構築することができます。

HTTP 要求フローおよびレスポンスボディ
Connect REST API のプロセスフロー (リソースおよび応答の例を含む) について確認します。

入力およびバイナリファイルのアップロードの例
入力を使用して HTTP POST、PATCH、PUT 要求を実行し、バイナリファイルのアップロードについて詳しく説明します。

ワイルドカード
Connect REST API と Connect in Apex の検索でテキストパターンを一致させるには、ワイルドカード文字を使用します。

応答サイズの指定
アプリケーションに必要なデータのみが返されるようにするには、絞り込みパラメーターを使用します。グループ別 (big、medium、または small) に応答サイズを指定するには、filterGroup を要求パラメーターとして、またはリクエストボディで使用します。さらに、特定のプロパティを除外したり、含めたりするには、exclude や include を要求パラメーターとして、またはリクエストボディで使用します。

レスポンスボディの符号化
応答は、デフォルトでは最小限に符号化された HTML エンティティになります。

状況コードとエラー応答
応答ヘッダーには、HTTP 状況コードが含まれます。応答が正常でない場合は、エラーメッセージがレスポンスボディに含まれ、必要に応じてエラーが発生した項目またはオブジェクトに関する情報も含まれます。

OAuth および Connect REST API
Connect REST API は、OAuth を使用してアプリケーションを Salesforce に接続する前にセキュアに識別します。

Web ブラウザーからのクロスオリジン要求の実行
クロスオリジンリソース共有 (CORS) を使用すると、Web ブラウザーで他のオリジンからのリソースを要求できます。たとえば、CORS を使用すると、https://www.example.com にある Web アプリケーションの JavaScript スクリプトで https://www.salesforce.com からのリソースを要求できます。Web ブラウザーの JavaScript コードから、サポートされている Salesforce API、Apex REST リソース、および Lightning Out へのアクセスを許可するには、要求元のオリジンを Salesforce CORS 許可リストに追加します。

Connect REST API リリースノート
Connect REST API の最新の更新や変更点については、Salesforce のリリースノートを参照してください。

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