REST API を使用する

学習の目的

この単元を完了すると、次のことができるようになります。

• Postman アプリケーションにログインし、Salesforce API コレクションの [REST] フォルダーに移動する。
• GET SObject Describe リソースを使用する。
• REST API を使用して取引先を作成する。
• REST API を使用してクエリを実行する。

メモ

日本語で受講されている方へ
Challenge は日本語の Trailhead Playground で開始し、かっこ内の翻訳を参照しながら進めていってください。Challenge での評価は英語データを対象に行われるため、英語の値のみをコピーして貼り付けるようにしてください。日本語の組織で Challenge が不合格だった場合は、(1) この手順に従って [Locale (地域)] を [United States (米国)] に切り替え、(2) [Language (言語)] を [English (英語)] に切り替えてから、(3) [Check Challenge (Challenge を確認)] ボタンをクリックしてみることをお勧めします。

翻訳版 Trailhead を活用する方法の詳細は、自分の言語の Trailhead バッジを参照してください。

REST のリソースとメソッド

ここでは、Postman を使用して API コールを行います。REST 要求は任意の HTTP 送信元から行うことができます。Postman は、API を介して Salesforce 組織とやり取りするのに使用できる多くのツールの 1 つにすぎません。  

最初のステップは、新しい Trailhead Playground を作成し、それを Postman アプリケーションに接続し、クロスオリジンリソース共有を設定し、Salesforce API コレクションへのフォークを作成することです。「Quick Start: Connect Postman to Salesforce (クイックスタート: Postman を Salesforce に接続する)」を修了することでこれを実行できます。 

Postman アプリケーションの Salesforce コレクションの [REST] フォルダーでリソースを使用して、他の HTTP インターフェースから行うのと同じように Trailhead Playground に対して REST API コールを実行できます。Salesforce API コレクションのリソースを選択すると、メインウィンドウの上部に URI が作成されます。 

Account オブジェクトに対する Describe

では、このしくみを見てみましょう。

SObject Describe リソースを使用します。このリソースは、GET メソッドと組み合わせると、オブジェクトおよびその項目に関するメタデータを返します。Account オブジェクトに describe を行うことにしましょう。 

1. コレクションで、Salesforce APIs コレクションのフォークを選択します。
2. [REST] フォルダーをクリックします。
3. [SObject] をクリックします。
4. [GET SObject Describe] をクリックします。
5. メインパネルで [Params (パラメーター)] タブを開きます。
6. [Path Variables (パス変数)] の下の [SOBJECT_API_NAME] 行の [VALUE (値)] 列に Account と入力します。

クエリの結果を見る前に、このリソースの URI を詳しく見てみましょう。

• GET — この API コールに使用される HTTP メソッド。
• {{_endpoint}} — 要求が実行される場所。この例では、Salesforce に接続するために変数の [_endpoint] 項目に Trailhead Playground の URL を追加しました。
• /services/data — REST API 要求を行うことを指定します。
• /v {{version}} — API バージョン番号。二重中括弧は、これを変数として設定できることを示します。
• /sobjects — sObject グルーピングの下のリソースにアクセスすることを指定します。
• /:SOBJECT_API_Name — アクションの対象となる sObject。この例では Account。
• /describe — アクション。この例では Describe 要求。

船長、うまくいきました！Account メタデータが画面に表示され、応答は見やすいように書式設定されています。未加工の JSON 応答を表示するには、[Raw (未加工)] をクリックします。

Account メタデータが JSON で表示されます。REST API は JSON と XML の両方をサポートしているため、XML 応答を指定するように要求ヘッダーを変更しましょう。 

1. 要求ウィンドウで [Headers (ヘッダー)] をクリックします。
2. [Key (キー)] を Accept、[Value (値)] を application/xml として、新しいヘッダーを追加します。

要求ヘッダーは次のようになります。

{
"Name": "Captain Bly’s Finest Treasure Chests",
"ShippingCity": "Lisbon"
}

{
"ShippingCity" : "Melbourne"
}

SELECT Name From Account WHERE ShippingCity = 'Melbourne'

Node.js および Ruby の例

const jsforce = require("jsforce");const conn = new jsforce.Connection({
  // you can change loginUrl to connect to sandbox or prerelease env.
  // loginUrl : "https://test.salesforce.com"
});
// Log in with basic SOAP login (see documentation for other auth options)
conn.login(
  process.env.USERNAME,
  process.env.PASSWORD + process.env.SECURITY_TOKEN,
  (err, res) => {
    if (err) {
      return console.error("Failed to log in to Salesforce: ", err);
    }
    console.log("Successfully logged in!");
    // Run a SOQL query
    conn.query("SELECT Id, Name FROM Account LIMIT 5", (err, result) => {
      if (err) {
        return console.error("Failed to run SOQL query: ", err);
      }
      // Display query results
      const { records } = result;
      console.log(`Fetched ${records.length} records:`);
      records.forEach(record => {
        console.log(`- ${record.Name} (${record.Id})`);
      });
    });
  }
);

require 'restforce'
# create the connection with the Salesforce connected app
client = Restforce.new :username => ENV['USERNAME'],
  :password       => ENV['PASSWORD'],
  :security_token => ENV['SECURITY_TOKEN'],
  :client_id      => ENV['CLIENT_ID'],
  :client_secret  => ENV['CLIENT_SECRET']
# execute the query
accounts = client.query("select id, name from account limit 5")
# output the account names
accounts.each do |account|
  p account.Name
end

リソース