Chatter REST API の概要 | Chatter REST API 開発者ガイド

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

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

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

リソース URL の作成
すべての Chatter REST API リソースへのアクセスには、会社のインスタンスの URI に、バージョンとコミュニティ情報、およびリソースの URI を組み合わせて使用します。

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

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

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

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

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

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

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

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

CORS を使用した、サポートされた Salesforce API、Apex REST、および Lightning Out へのアクセス
Apex REST、Bulk API、Chatter REST API、Lightning API、Lightning Out、REST API、Wave REST API では、CORS (クロスオリジンリソース共有) がサポートされます。Web ブラウザで JavaScript からこれらの API にアクセスするには、スクリプトを提供するオリジンを CORS ホワイトリストに追加します。