cq-wbapi

开放桥接口库

Usage no npm install needed!

<script type="module">
  import cqWbapi from 'https://cdn.skypack.dev/cq-wbapi';
</script>

README

正式版调试

请使用chrome的inspect调试(需翻墙/或者使用chrome内核部分浏览器)

chrome://inspect/#devices

1、npm方式引入

npm i cq-wbapi
import { setDevelopmentMode , WebBridgeApi } from "cq-wbapi"

2、script引入,支持es5

<script src="https://img11.iqilu.com/0/api/cq-wbapi.min.js"></script>

cq-wbapi接口文档



//开发模式(开发环境) 特别注意!!:此条语句只有在测试环境下才用!
//默认是正式环境
//setDevelopmentMode(true);


接口 requestApi

获取用户信息,未登录不会触发登录

接收参数 无

返回参数:

返回用户基本信息

示例


WebBridgeApi.requestApi('getUserInfo').then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 getUserInfo

获取用户信息,未登录不会触发登录

接收参数 无

返回参数:

返回用户基本信息

字段 说明
avatar 头像
orgID 机构ID
openID 机构的用户唯一ID
nickname 昵称

示例



WebBridgeApi.getUserInfo().then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 authorize

获取用户授权,未登录会触发登录

接收参数 无

返回参数:

返回用户基本信息

字段 说明
avatar 头像
orgID 机构ID
openID 机构的用户唯一ID
nickname 昵称
token 用户授权信息

示例



WebBridgeApi.authorize().then(({ err, result }) => {
  console.log("测试桥返回结果", result, err);
});

接口 share

分享

示例

WebBridgeApi.share({share:{title:'',desc:'',image:'',url:''}}}).then(({ err, result }) => {
  
});

接收参数

参数 说明
share 标准的分享字段,包含title,desc,image,url

返回参数:

String 分享结果消息