Salesforce 擴充功能

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

版本：1.0.3

存取 Salesforce 帳戶中的資料。插入、更新、擷取及查詢資料。

本文提供設定和使用這個擴充功能的參考資料。

必要條件

本文提供設定和使用這個擴充功能的參考資料。透過 Extension callout 政策透過 API Proxy 使用擴充功能前，您必須：

1. 建立 RSA x509 私密金鑰/認證組合。

   您在設定擴充功能時，會使用私密金鑰 (.key) 做為憑證。建立的連結應用程式會將 Salesforce 存取權授予擴充功能時，您就需要使用憑證 (.crt) 檔案。

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. 設定連結的應用程式。

   與 Salesforce 連結的應用程式會提供 Salesforce 擴充功能的存取權。請參閱以下操作說明，瞭解如何設定應用程式。

3. 取得已連結應用程式的用戶端金鑰。擴充功能會在驗證應用程式時使用。

   1. 在 Salesforce 設定的左側導覽面板中，依序前往「應用程式」>「App Manager」。
   2. 在清單中，找出您建立的連結應用程式。
   3. 在應用程式列的右側下拉式選單中，按一下「查看」。
   4. 在「API (啟用 OAuth 設定)」下方找出「用戶端金鑰」，並將其值複製到設定擴充功能時的安全位置。

設定連結的應用程式，供擴充功能存取

您必須先建立 Salesforce 連結的應用程式，這個擴充功能可透過 Salesforce 連結，才能存取 Salesforce 擴充功能。

在 Salesforce 中，連結的應用程式可讓外部應用程式透過 API 連線至 Salesforce。

如何設定連結的應用程式

1. 登入 Salesforce。
2. 按一下右上角的齒輪圖示，然後點選「設定」。
3. 在左側導覽面板中，依序展開「應用程式」>「應用程式管理員」。
4. 在「App Manager」頁面中，按一下「新增連結的應用程式」。
5. 填寫「Basic Information」下方的必填欄位。這些值僅供簿記，不會用於擴充功能。
6. 在「API (啟用 OAuth 設定)」下方，勾選「啟用 OAuth 設定」核取方塊。
7. 雖然額外資訊沒有使用這個參數，但請輸入「回呼網址」。您可以使用 http://localhost/ 或其他預留位置主機。
8. 勾選「使用數位簽章」核取方塊。
9. 按一下「使用數位簽章」下方的「選擇檔案」，找出並上傳您先前產生的 salesforce.crt。
10. 在「已選取的 OAuth 範圍」部分新增下列內容，將這些範圍列在「已選取的 OAuth 範圍」底下：
    • 存取及管理您的資料 (API)
    • 隨時代表您執行要求 (refresh_token、Offline_access)
11. 按一下「儲存」，如有任何錯誤，您可能需要重新產生並上傳 salesforce.crt 檔案。
12. 在隨即顯示的應用程式頁面中，按一下「管理」。
13. 在剛建立的應用程式「應用程式管理員」頁面中，按一下「編輯政策」。
14. 在「OAuth 政策」下方，點選「許可的使用者」下拉式選單，然後點選「管理員核准的使用者是否獲得預先授權」。
15. 點按「儲存」。
16. 返回應用程式頁面，然後在「個人資料」下方點選「管理個人資料」。

17. 在「應用程式設定檔指派」頁面中，勾選可使用這個應用程式的使用者設定檔核取方塊。

    請務必根據設定擴充功能時使用的使用者名稱，選取該使用者對應的設定檔。同時確認至少有系統管理員使用者有權存取這個應用程式。

    您可以在 Salesforce 中查看使用者的個人資料設定。在「設定」區域中，展開「使用者」>「使用者」，找出擴充功能代表的使用者，然後在「設定檔」欄中找出其設定檔。

18. 點按「儲存」。

關於 Salesforce

Salesforce 是客戶關係管理 (CRM) 平台，客戶關係管理服務有助於公司瞭解客戶的需求並解決問題，也就是提供更完善的客戶資訊和互動管理方式，而且這些平台隨時可以透過任何電腦或裝置存取。

動作

insert

以 sObject type 格式插入記錄。

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

要求參數

回應

包含插入作業結果的 results 陣列。

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

update

更新 Salesforce 記錄。

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { 
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName" 
    }
  ],
  "allOrNone": true
}]]></Input>

要求參數

回應

包含更新結果的 results 陣列。

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

retrieve

以 sObjects 的形式擷取記錄。傳回 sObject 類型的所有欄位。

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

要求參數

回應

以 JSON 表示的 sObjects records 陣列。請注意，即使屬性值為空值，物件的所有屬性也會納入 JSON 中。

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

querySOQL

使用 Salesforce 物件查詢語言 (SOQL) 查詢 Salesforce.com。

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

要求參數

回應

查詢結果。

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

list

列出 Salesforce.com 記錄。傳回指定 sObject 類型的所有欄位。

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

要求參數

回應

包含以 JSON 格式列出 sObjects 的 records 陣列。

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

DEL

刪除具有指定 ID 的記錄。

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

要求參數

回應

包含作業結果的 results 陣列。

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

getAccessToken

取得 Salesforce.com API 存取權杖。可用於查詢 REST API。

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

要求參數

無。

回應

JSON 中的存取權杖。

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

設定參考資料

如果您要設定及部署這個擴充功能，以便用於 API Proxy，請按照下列指示操作。

常見擴充功能屬性

每個擴充功能都有下列屬性。

這個擴充功能套件的屬性

指定這個擴充功能的下列設定屬性值。