3vot-salesforce-proxy 中文文档教程

Question

3vot-salesforce-proxy

WHY

Salesforce 使用 OAUTH 2.0 用于身份验证，不提供直接从 Web 应用程序连接的 CORS。

更重要的是，Salesforce REST API 并不是为前端友好而设计的。 大多数模型和 AJAX 模块都不起作用。 Salesforce 应用程序开发人员最终不使用模型并直接与 Salesforce REST API 通信。 这种方法需要 APEX 和 Salesforce 的知识，使应用程序开发变得更加昂贵并且破坏了 M*VC。

What

用 NodeJS 编写的生产代理服务器，具有将标准传统 REST 转换为 Salesforce Rest API 的集群。 它使在 Javascript 中使用 Salesforce Data 变得容易。

开发人员可以简单地创建对象 Account.create({ Name: "Acme" }) - 查询 Account.query("select id, name from account") - 更新和删除'account.save()' - 'account.delete()'。

通过这种方式，前端开发人员可以构建 Salesforce 应用程序，从而降低成本并将开发速度提高 3 倍以上。

服务器包括基于 oauth2 或密码的登录，处理会话刷新并且它是无状态的，因此它可以立即扩展到无限大。

How

只需使用 Heroku 按钮即可让您的代理服务器立即运行！

从 NPM 部署通过使用文件 app.js 或 bin/www 作为节点启动脚本。

在您自己的服务器中使用 routes/login 和 routes/api 中的路由，确保您使用的是 cookie-session NPM 模块

More

This Server is part of ClayForSalesforce.com< /a> ，一个在浏览器和移动设备中为 Salesforce 开发现代前端应用程序作为 Visualforce/静态资源的平台。

Salesforce 有一个特殊的 Rest 特质，因为它为更新和删除返回 null，它们混合 Id 和 id 字段并返回包装在另一个对象中的 Rest 结果。 如果您解决了这个问题，它应该适用于大多数 Ajax 模型。

ClayforSalesforce 有一个名为 Clay Model 的多功能模型，可以与名为 clay-model-salesforce-api 的 Salesforce APi 适配器结合使用，这使得一切都开箱即用，并且作为一个附加功能，仅在更新时发送修改的字段，这非常棒在处理 CRUD 和 FLS 安全上下文中的更新时。

该软件包由 3VOT Corporation 提供支持。

Install

$ npm install 3vot-salesforce-proxy

Setup

安装可以通过使用 Heroku 按钮稍微加速 > APP_NAME，然后是 heroku clone 和 heroku config:pull

1. 为本地主机 (localhost:5000) 和生产环境创建一个 Salesforce Connect 应用程序（使用您的服务器 url 或 xxxx.herokuapp。 com )

2. 设置以下 ENV 变量文件 .env 和 .denv SALESFORCECLIENTID、SALESFORCECLIENTSECRET、SALESFORCEREDIRECTURL、NODE_ENV、ORIGINS

检查此要点以获得快速格式：https://gist。 github.com/rodriguezartav/b5ed90528075777d2edd

Getting Started

启动服务器 生产 foreman start - 自动加载 .env 生产 ./bin/ww - 加载 .env 开发 ./bin/w - 加载 .denv

将浏览器指向 http://localhost:5000/login ，检查 /session 和 /whoami

Using from an App

首先你必须登录，将浏览器指向 /login路由确保提供和 appurl 查询字符串变量。 这是登录后代理将重定向到的 URL。 您还可以将该值硬编码为名为 SALESFORCEFINAL_URL 的 ENV-VARIABLE

现在使用 OBJECT/ID url 的

Get 请求进行常规 HTTP REST API 调用 GET、POST、PUT、DEL 与 ?query=select… querystring 被视为 SOQL查询，添加 autoFetch 和 maxFetch 查询字符串参数来控制返回多少条记录。 即：http://localhost:5000/Account?query="select id, name from Account&autoFetch=true&maxFetch=10000"

也可以使用 Apex Rest 路由 [GET,POST,PUT,DEL,PATCH] apex/方法，其中方法是 APEX 测试方法名称。 当 [POST,PUT,DEL,PATCH] 时，可以在 http 正文中提供参数，对于 GET 请求，包括带有方法名称的查询字符串。 apex/method?param1=true

Rules

登录后代理将根据以下规则重定向：

1. appurl: It will use the appurl query string provided to the login route. /login?app_url=myapp.com/start
2. SALESFORCEFINALURL: ENV variable that points to a final route, use it when you only have one app.
3. /login/whoami: By default, the proxy will redirect to the whoami route, the browser will end up here so it's not good to use the default other than when testing for development.

如果您在开发中运行代理，还有 /session 路由。 会输出Salesforce Security Token，这个对测试有效，方便获取token。 它不会在生产中可用，因为您将 ENV 变量 NODE_ENV 设置为“生产”

Using the Proxy

代理基于并使用 jsforce，因此请跟进 JSFORCE 文档，研究此 repo 中提供的测试或请求我们的支持。

该代理旨在开箱即用地使用 Javascript 模型，特别是使用 clay-model-salesforce-api 的粘土模型。

使用粘土模型时，在 Salesforce 内部部署的 Visualforce Remoting 或使用 API 和此代理外部​​部署的应用程序无需修改代码。

有关使用代理的更多信息可以在 Github 的 3VOT Profile 中的 clay-model 和 clay-model-salesforce-api 存储库中找到。

CORS

在环境变量 ORIGINS=*.DOMAIN.com 上设置允许的域，其他域以 ',' 分隔

Clustering

此 API 代理服务器启用了集群，我们还使用分叉来确保任何未处理的异常都不会停止服务器，只是工人，而主人刚刚启动了一个新工人。

Using in another server

为了在您的服务器中使用此代理，只需使用登录名和 api 路由即可。 登录路由并不是真正必需的，只要在会话中定义了 salesforce 属性即可。 就像 salesforce 返回它一样存储 saleforce 属性。

Testing

首先创建并填写在开发上运行的文件 .denv。 确保创建指向 http://localhost:5000/login/callback 的 Salesforce Connected App，并在 .denv 文件中设置客户端 ID 和密码。

使用 Tape，运行 tape ./test

Support

3VOT Saleforce Proxy 由 3VOT Corporation 支持，它是 Clay Plataform @ 3vot.com 的核心组件，

谢谢