Salesforce 扩展程序

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

版本：1.0.2

访问 Salesforce 账号中的数据。插入、更新、检索和查询数据。

本文提供了配置和使用此扩展程序的参考信息。

前提条件

本文提供了配置和使用此扩展程序的参考信息。在通过 API 代理通过 ExtensionCallout 政策使用扩展程序之前，您必须：

1. 创建一个 RSA x509 私钥/认证对。

   配置扩展程序时，您需要将私钥 (.key) 用作凭据。您在创建关联的应用时需要使用该证书 (.crt) 文件，以便允许扩展程序访问 Salesforce。

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

2. 设置关联的应用。

   与 Salesforce 关联的应用将提供对 Salesforce 扩展程序的访问权限。请参阅下文，了解如何设置应用。

3. 获取已连接应用的使用方密钥。该扩展程序在向应用进行身份验证时将使用此 ID。

   1. 在 Salesforce 设置中的左侧导航栏中，转到应用 >应用管理器。
   2. 在列表中，找到您创建的已关联的应用。
   3. 在应用行右侧的下拉菜单中，点击查看。
   4. 在 API（启用 OAuth 设置）下，找到使用方键值，并将其值复制到安全位置，以便在配置扩展程序时使用。

设置关联的应用以供扩展程序访问

您需要先创建 Salesforce 关联的应用，此扩展程序可以通过该应用与 Salesforce 连接，然后 Salesforce 扩展程序才能访问 Salesforce。

在 Salesforce 中，关联的应用为外部应用提供了一种通过 API 连接到 Salesforce 的方式。

设置关联的应用

1. 登录 Salesforce。
2. 点击右上角的齿轮图标，然后点击设置。
3. 在左侧导航栏中，展开应用 > 应用管理器。
4. 在应用管理器页面中，点击新建关联的应用。
5. 在基本信息下，填写必填字段。这些值用于记账；它们不会被扩展程序使用
6. 在 API（启用 OAuth 设置）下，选中启用 OAuth 设置复选框。
7. 请输入一个回调网址，虽然该扩展程序并不会使用该网址。您可以使用 http://localhost/ 或其他一些占位主机。
8. 选中使用数字签名复选框。
9. 在 Use digital signatures（使用数字签名）下，点击 Choose File（选择文件）以查找并上传您之前生成的 salesforce.crt。
10. 在选定的 OAuth 范围部分，添加以下内容，使其显示在选定的 OAuth 范围下： <ph type="x-smartling-placeholder">
    </ph>
    • 访问和管理您的数据 (api)
    • 随时代表您执行请求（refresh_token、offline_access）
11. 点击保存。如果存在任何错误，您可能需要重新生成并上传 salesforce.crt 文件。
12. 在出现的应用页面上，点击管理。
13. 在刚刚创建的应用的“应用管理器”页面上，点击修改政策。
14. 在 OAuth 政策下，点击允许的用户下拉菜单，然后点击管理员批准的用户已获得预先授权。
15. 点击保存。
16. 返回应用页面，在配置文件下，点击管理配置文件。

17. 在应用配置文件分配页面上，选中可以使用此应用的用户个人资料对应的复选框。

    请务必根据您在配置扩展程序时要使用的用户名所对应的用户选择一份个人资料。此外，请确保至少有系统管理员用户访问此应用。

    您可以在 Salesforce 中查看该用户的配置文件设置。在设置区域，展开用户 >用户，找到该扩展程序所代表的用户，然后在个人资料列中找到该用户的个人资料。

18. 点击保存。

Salesforce 简介

Salesforce 是一个客户关系管理 (CRM) 平台。客户关系管理可帮助各公司了解其客户的通过更好地管理客户信息和互动来满足客户需求和解决问题 - 所有这一切都在一个始终可通过任何桌面设备或设备访问的平台上实现。

操作

insert

以 sObject 类型的形式插入记录。

<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

按 ID 将记录检索为 sObject。返回 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 表示的 sObject 的 records 数组。请注意，即使属性值为 null，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 格式列出的 sObject 的 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 代理中使用时，请使用以下代码。

常见的扩展属性

每个扩展程序都有以下属性。

此扩展程序软件包的属性

为此扩展程序的以下配置属性指定值。