REST API 開発者ガイド
jステップ 3: cURL で HTTP 要求を送信する
Lightning Platform REST API を操作するには、HTTP 要求を構築するようにクライアントアプリケーションを設定する必要があります (cURL を使用します)。
クライアントアプリケーションの設定
REST API は、HTTP GET メソッドおよび HTTP POST メソッドを使用して JSON と XML コンテンツを送信および取得するため、好みのツールまたは言語を使って簡単にクライアントアプリケーションを構築できます。HTTP 要求と応答の送受信を単純化するために、cURL というコマンドラインツールを使用します。
cURL は、多くの Linux システムや Mac システムにあらかじめインストールされています。Windows バージョンは、curl.haxx.se/ からダウンロードできます。Windows で HTTPS を使用する場合、システムが SSL の cURL 要件を満たしていることを確認してください。
REST API リソースを使った HTTP 要求の送信
REST API リソースへの HTTP 要求には、次の情報が含まれている必要があります。
- HTTP メソッド (HEAD、GET、POST、PATCH、または DELETE)。
- 要求の認証に使用される OAuth 2.0 アクセストークン。トークンの取得方法については、「クイックスタート」を参照してください。
- リソースの形式 (XML または JSON)、または URI の .json または .xml 拡張子を示すために使用する HTTP ACCEPT ヘッダー。デフォルトは JSON です。
- Lightning Platform REST リソース。
- 新しい情報でレコードを更新するなどの要求に必要な情報が含まれる JSON ファイルまたは XML ファイル。
HTTP メソッドは、情報の取得や、レコードの作成、更新、削除など、目的のアクションを示すために使用されます。
- HEAD は、リソースメタデータの取得に使用されます。
- GET は、リソースに関する基本的なサマリー情報など、情報の取得に使用されます。
- POST は、新しいオブジェクトを作成するために使用されます。
- PATCH は、レコードを更新するために使用されます。
- DELETE は、レコードを削除するために使用されます。
リソースにアクセスするには、ヘッダー、メソッド、リソース名を含む HTTP 要求を送信します。
たとえば、newaccount.json という JSON 形式のファイルを使用して、Account レコードを作成するとします。これには、新しい Account レコードに保存される情報が含まれます。
インスタンスに cURL を使用すると、要求は次のようになります。
HTTP 要求ヘッダーは次のようになります。
応答は次のようになります。
リソースおよび対応する URI のリストについては、「リファレンス」を参照してください。