https://github.com/jpush/jpush-api-nodejs-client
JPush's officially supported Node.js client library for accessing JPush APIs. 极光推送官方支持的 Node.js 版本服务器端 SDK。
https://github.com/jpush/jpush-api-nodejs-client
Last synced: 8 months ago
JSON representation
JPush's officially supported Node.js client library for accessing JPush APIs. 极光推送官方支持的 Node.js 版本服务器端 SDK。
- Host: GitHub
- URL: https://github.com/jpush/jpush-api-nodejs-client
- Owner: jpush
- License: gpl-2.0
- Created: 2013-10-12T07:27:31.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T10:19:58.000Z (10 months ago)
- Last Synced: 2025-04-11T21:48:50.211Z (9 months ago)
- Language: JavaScript
- Homepage: https://docs.jiguang.cn
- Size: 234 KB
- Stars: 240
- Watchers: 24
- Forks: 73
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JPush API client library for Node.js
本 SDK 提供 JPush 服务端接口的 Node 封装，与 JPush Rest API 组件通信。使用时引用该模块即可，可参考附带 Demo 学习使用方法。
> Node >= 7.6（async/await 语法支持），若 node 版本小于 7.6 请使用 [legacy 分支的代码](https://github.com/jpush/jpush-api-nodejs-client/tree/legacy)
[REST API 文档](http://docs.jiguang.cn/jpush/server/push/server_overview/)
[NodeJS API 文档](https://github.com/jpush/jpush-api-nodejs-client/blob/master/doc/api.md)
## Install
```
npm install jpush-async
#or
{
"dependencies": {
"jpush-async": "*"
}
}
```
## Example
### Quick start
此 Demo 展示如何使用 Node lib 向所有用户推送通知。
``` js
var JPush = require("../lib/JPush/JPushAsync.js")
var client = JPush.buildClient('your appKey', 'your masterSecret')
//easy push
client.push().setPlatform(JPush.ALL)
.setAudience(JPush.ALL)
.setNotification('Hi, JPush', JPush.ios('ios alert', 'happy', 5))
.send()
.then(function(result) {
console.log(result)
}).catch(function(err) {
console.log(err)
})
```
### Expert mode（高级版）
```js
client.push().setPlatform('ios', 'android')
.setAudience(JPush.tag('555', '666'), JPush.alias('666,777'))
.setNotification('Hi, JPush', JPush.ios('ios alert'), JPush.android('android alert', null, 1))
.setMessage('msg content')
.setOptions(null, 60)
.send()
.then(function(result) {
console.log(result)
}).catch(function(err) {
console.log(err)
});
```
关于 Payload 对象的方法，参考[详细 API 文档](https://github.com/jpush/jpush-api-nodejs-client/blob/master/doc/api.md)。
### 关闭 Log
```js
// 在构建 JPushClient 对象的时候, 指定 isDebug 参数。
var client = JPush.buildClient({
appKey:'your appKey',
masterSecret:'your masterSecret',
isDebug:false
});
// or
var client = JPush.buildClient('your appKey', 'your masterSecret', null, false);
```
> 目前使用了 debug 模块来控制日志输出，若要查看 JPush 的相关日志信息，请先配置 DEBUG 环境变量 'jpush'。