# JSAPI 接入指南

# JSAPI 总览

# npm 安装

1、使用 npm 安装
地址:https://www.npmjs.com/package/yach-jsapi
安装:

npm install yach-jsapi --save
1

使用示例:

import yy from "yach-jsapi"; //yy可以自己定义

yy.biz.util.openLink({
  url: "https://yach.zhiyinlou.com", //要打开链接的地址
  onSuccess: function(result) {
    /*成功回调*/
  },
  onFail: function(err) {
    /*失败回调*/
  }
});
1
2
3
4
5
6
7
8
9
10
11

# 浏览器引入

在浏览器中使用 script 和 link 标签直接引入文件,并使用全局变量 yy。

<script
  src="https://yach-static.zhiyinlou.com/web_static/yach_open/yach_api_0.1.js"
  type="text/javascript"
></script>
1
2
3
4

目前地址:https://yach-static.zhiyinlou.com/web_static/yach_open/yach_api_0.1.js

# 接口约定

  1. 所有接口都为异步
  2. 接受一个 object 类型的参数
  3. 成功回调 onSuccess(某些异步接口的成功回调,将在事件触发时被调用,会在 api 文档中详细说明)
  4. 失败回调 onFail
yy.命名空间.功能.方法({
  参数1: "",
  参数2: "",
  onSuccess: function(result) {
    //成功回调
  },
  onFail: function(err) {
    //失败回调
  }
});
1
2
3
4
5
6
7
8
9
10

# JSAPI 说明

# 鉴权 api

设计到数据、安全方面的 api 需要进行鉴权处理
鉴权示例

yy.config({
  agentId: "1591562343", // 必填,微应用ID
  corpId: "1", //必填,企业ID,好未来为1
  timeStamp: "1583126111", // 必填,生成签名的时间戳
  nonceStr: "Yach_record_8858", // 必填,生成签名的随机串
  signature: "eb63220caf3485106ff7978", // 必填,签名
  type: 0, //选填。不填默认为0。
  jsApiList: ["biz.chat.pickConversation", "biz.util.open"], // 必填,需要使用的jsapi列表,注意:不要带yy。
  onSuccess: function(result) {
    //成功回调
    /*{
      	code:200,
        msg:鉴权成功
      }*/
  },
  onFail: function(err) {
    //失败回调
    /*{
      	code:错误吗,
        msg:错误信息
      }*/
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
参数 参数类型 必须 说明
agentId String 微应用 ID
corpId String 企业 ID,好未来为 1
timeStamp String 生成签名的时间戳
nonceStr String 生成签名的随机串
signature String JS-API 签名
type number 预留字段,可不传,默认为 0
jsApiList Array 需要调用的 jsapi 列表

# 非鉴权 api

不用做特使处理,直接调用即可
示例:

import yy from "yach-jsapi"; //yy可以自己定义

yy.biz.util.openLink({
  url: "https://yach.zhiyinlou.com", //要打开链接的地址
  onSuccess: function(result) {
    /*成功回调*/
  },
  onFail: function(err) {
    /*失败回调*/
  }
});
1
2
3
4
5
6
7
8
9
10
11

# yy.ready

用来标识文档加载完毕。

# 页面监听事件

# 页面 resume 事件的回调监听

Android iOS PC
支持 支持 不支持

# 使用说明

当页面重新可见并可交互时,yach 会产生回调,开发者可监听此 resume 事件,并处理开发者自己的业务逻辑。

# 注意

此和原生 addEventListener 行为一致,多页面应用要合理清除事件,防止内存泄漏等问题
示例:

import yy from "yach-jsapi";

function ceshi() {
  //处理自己逻辑
}

// 绑定事件
yy.on("resume", ceshi);
// 清除事件
yy.on("resume", ceshi);
1
2
3
4
5
6
7
8
9
10
上次更新: 3/21/2020, 9:06:42 PM