yly-nodejs-sdk

sdk for yly openapi

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
yly-nodejs-sdk
2012.0.413 days ago5 years agoMinified + gzip package size for yly-nodejs-sdk in KB

Readme

yly-nodejs-sdk

Build Status

Requirement
node,npm
Installation
npm install yly-nodejs-sdk --save
```  

# Usage || instructions
1. 接口类lib/api/*.js,集成了所有的易联云接口
2. 配置类config.js
3. 授权类oauth_client.js,获取调用凭证AccessToken,每日上限次数20次,24小时后更新次数
4. 接口调用类rpc_client.js,可以直接用这个类直接进行接口调用

### 第1步引入sdk
```js
var yly = require('yly-nodejs-sdk');   

第2步实例化一个配置对象

var config = new yly.Config({
    'cid' : '',         //应用id
    'secret' : ''       //应用秘钥
});

第3步实例化一个oauth2.0客户端授权模式的授权对象

var oauthClient = new yly.OauthClinet(config);

第4步获取调用凭证token对象(返回值为一个promise),此步获取到的token对象可在有效期内一直使用,不用每次调用前都去获取一次,建议应用授权一次后存放到全局缓存中

oauthClient.getToken().then(function (res){
    if (
        res.error != 0 &&
        res.error_description != 'success'
    ) {
        throw new Error('failed:' + res.error_description);
    }
    var tokenData = {
        'accessToken' : res.body.access_token,
        'refreshToken' : res.body.refresh_token,
    };
    if (res.body.machine_code != null) {
        tokenData.machineCode = res.body.machine_code;
    }
    console.log(tokenData);
});

第5步实例化远程调用的rpcClient对象

var RpcClient = new yly.RpcClient(accessToken, config);

第6步实例化一个API对象

var Print = new yly.Print(RpcClient);

第7步调用服务方法,获取资源数据,返回promise对象

Print.index(machineCode, originId, content).then(function(res){
    console.log(res);
});
ChangeLog

v2.0.4

  1. Release Date : 2024-05-08
  2. Feature printer/pushswitch api 新增mode字段

v2.0.3

  1. Release Date : 2023-11-01
  2. Featurev2新增K8推送开关设置接口。
  3. Featurev2新增K8高级设置接口。

v2.0.1

  1. Release Date : 2023-10-18
  2. Featurev2更新K8关键词设置接口。

v2.0

  1. Release Date : 2023-06-07
  2. Feature更新接口v2.0版本,文档
  3. Featurev2新增订单重打(单订单)接口。
  4. Featurev2新增面单取消