@chatopera/node-dscrm

大盛 CRM nodejs client

Usage no npm install needed!

<script type="module">
  import chatoperaNodeDscrm from 'https://cdn.skypack.dev/@chatopera/node-dscrm';
</script>

README

大盛 CRM SDK for node client

大盛 CRM，精致好用的 CRM 系统。

npm install -i @chatopera/node-dscrm

Usage

const Dscrm = require("@chatopera/node-dscrm");

const client = new Dscrm("YOUR_SERVER_BASE_URL",
    {grant_type: "client_credentials",
    client_id: "YOUR_CLIENT_ID",
    client_secret: "YOUR_CLIENT_SECRET"},
    XDEBUG_SESSION_START)

其中，YOUR_SERVER_BASE_URL/YOUR_CLIENT_ID/YOUR_CLIENT_SECRET是实例 URL 地址，客户端认证 ID 和密钥，以上为必须参数；XDEBUG_SESSION_START是可选参数，作为 xdebug 调试用的 session，默认为 null 时 Server 不进行断点调试。

APIs

调用 API 有两种形式，一种是 SDK 已经实现了明确的方法名的；一种是 SDK 没有实现明确方法名，但是大盛 CRM 中已经有了 RestAPI 的。

明确方法名#getCurrentUser

let resp = await client.getCurrentUser();

未明确方法名

await client.command(METHOD, PATH, BODY)

其中，METHOD 可以是 "GET", "POST", "PUT", "DELETE" 等；PATH是服务基础 URL 追加的部分，比如/Api/V8/user-preferences/1, 可以携带有params或queryString; BODY，发送请求的 JSON 数据。

示例

let ret = await client.command("GET", "/Api/V8/user-preferences/1");

为明确的方法名使用参考 SuiteCRM/api/routes.php。

返回值

不同 API 返回的结果都是一个 JSONObject，带有返回的数据。 如果请求出现异常，会抛出Error，建议用 Try/Catch 获取。

贡献

npm i
cp sample.env .env # edit .env with your credentials
npm test

开源许可协议

Copyright (2018-2020) 北京华夏春松科技有限公司

Apache License Version 2.0

chatoper banner