接入指南

按步骤完成 EasyPush 接入

从获取 AppKey、引入 JSSDK,到建立连接、订阅通道和发送第一条消息, 这页把接入所需的关键步骤集中整理在一起。

Step 0

获取 AppKey

先在管理控制台注册账号并创建应用,创建完成后即可获得 AppKey。 AppKey 用于标识当前应用,是后续初始化 SDK 和调用接口时的核心参数。

Step 1

客户端集成 JSSDK

在客户端页面通过以下脚本引入 EasyPush JSSDK:

<script type="text/javascript" src="./js/EasyPush-min.js"></script>

发布当前目录时,也可以直接使用 本地 JSSDK 文件

Step 2

初始化 EasyPush

通过 EasyPush.init 完成客户端初始化:

var easyPush = EasyPush.init({
  host: 'ep.eastech-inc.com',
  appkey: 'your-appkey',
  clientId: 'user001'
});
名称 是否必填 值示例 说明
host ep.eastech-inc.com 云推送服务器域名,目前固定为 ep.eastech-inc.com。
appkey SZpLjHJpz5S92dGGeegkVEBq4H717O6P 应用对应的 AppKey,可在管理控制台的应用管理中查看。
clientId user001 用于标识当前客户端身份,建议使用系统中的唯一标识,如用户 ID;不传时服务器会自动生成。
注意:一个页面只需要初始化一次。
Step 3

连接到云推送服务器

初始化完成后,通过以下代码建立连接:

easyPush.connect({
  onSuccess: function () {
    // to do something
  },
  onFailed: function (message) {
    console.log(message);
    // to do something
  }
});
Step 4

订阅通道接收消息

连接成功后再订阅通道,收到消息时回调 onMessage:

easyPush.subscribe({
  channel: 'channel0',
  onMessage: function (channel, data) {
    // to do something
  },
  onSuccess: function () {
    // to do something
  }
});

channel 表示订阅的通道名称,通道无需预先创建;onMessage 会在收到消息时自动触发, 其中 channel 代表当前通道名称,data 代表接收到的消息内容。

注意:订阅方法应在连接成功后调用,推荐放在 connect 的 onSuccess 回调中执行。
Step 5

发送消息

EasyPush 支持通过 API 接口管理控制台客户端 JSSDK三种方式发送消息。以下示例演示通过 JSSDK 发送消息:

easyPush.publish({
  message: 'Hello, EasyPush',
  channel: 'channel0',
  onSuccess: function () {
    // to do something
  }
});

message 表示发送内容,channel 表示目标通道。发送成功后,所有订阅该通道的客户端都会收到这条消息。

通过以上步骤即可完成基础接入。你也可以下载 完整版 Demo 进一步了解客户端 JSSDK 的使用方式。