微信小程序接入指南
引入 SDK 并初始化
使用知晓云 SDK 小程序插件,相对于引入 SDK js 文件方式,省去了下载 SDK 文件和配置服务器域名操作,同时可以更加方便的切换不同版本的 SDK。
添加知晓云 SDK 小程序插件
在小程序的管理后台【设置】-【第三方服务】-【插件管理】中添加插件,根据知晓云 SDK 小程序插件的 AppID 「wxc6b86e382a1e3294」搜索到我们的插件,添加后等待审核,审核通过即可使用。
在项目配置中声明使用知晓云 SDK 小程序插件
插件版 sdk 1.5.1 以上需小程序基础库 2.1.0 及以上。
在项目的配置文件 app.json
中对插件进行引入声明:
"plugins": {
"sdkPlugin": {
"version": "3.6.0",
"provider": "wxc6b86e382a1e3294"
}
}
目前知晓云 SDK 小程序插件提供如下版本:
插件版 SDK 版本 | 对应 js 文件版 SDK 版本 |
---|---|
0.1.0 | v1.2.0 |
1.3.0 及之后 | 与文件版的版本号同步 |
初始化 SDK
wx.BaaS.init(clientID, options)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
clientID | String | Y | 知晓云管理后台获取到的 ClientID |
options | InitOption | N | 其他选项 |
InitOption:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
autoLogin | Boolean | N | 请求知晓云接口时,是否自动静默登录,默认为 false |
logLevel | String | N | 日志输出级别,共支持 debug、info、warn、error 4 个级别,默认为 error |
host | String | N | 自定义域名 |
env | String | N | 开发环境 ID,用于区分生产环境与其他开发环境,默认为生产环境 |
关于 autoLogin 参数,具体请参考多平台用户统一登录 和 迁移指南。
clientID 在知晓云管理后台获取。
通过初始化 SDK ,知晓云服务可以验证当前的小程序是否是有效合法的,只有通过验证的小程序才能使用 SDK 提供的全部功能。
在知晓云后台 - 我的应用页面获取要接入知晓云服务的小程序 ClientID, 按照如下方式进行 SDK 初始化:
//app.js
App({
onLaunch: function() {
wx.BaaS = requirePlugin('sdkPlugin')
//让插件帮助完成登录、支付等功能
wx.BaaS.wxExtend(wx.login, wx.getUserInfo, wx.requestPayment)
let clientID = '[[client_id]]' // 应用名称: [[app_name]]
wx.BaaS.init(clientID)
}
})
下载并导入 SDK
b. 将下载解压后得到的 SDK js 文件放在小程序项目目录中
// app.js
App({
onLaunch() {
// require SDK
require('./sdk-v3.7.0')
}
})
初始化 SDK
wx.BaaS.init(clientID, options)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
clientID | String | Y | 知晓云管理后台获取到的 ClientID |
options | InitOption | N | 其他选项 |
InitOption:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
autoLogin | Boolean | N | 请求知晓云接口时,是否自动静默登录,默认为 false |
logLevel | String | N | 日志输出级别,共支持 debug、info、warn、error 4 个级别,默认为 error |
host | String | N | 自定义域名 |
env | String | N | 开发环境 ID,用于区分生产环境与其他开发环境,默认为生产环境 |
关于 autoLogin 参数,具体请参考多平台用户统一登录 和 迁移指南。
clientID 在知晓云管理后台获取。
通过初始化 SDK ,知晓云服务可以验证当前的小程序是否是有效合法的,只有通过验证的小程序才能使用 SDK 提供的全部功能。
在知晓云后台 - 我的应用页面获取要接入知晓云服务的小程序 ClientID, 按照如下方式进行 SDK 初始化:
// app.js
App({
onLaunch() {
// 引入 SDK
require('./sdk-v3.7.0')
let clientID = '[[client_id]]'
wx.BaaS.init(clientID)
}
})
完成服务器域名配置
在这里可查看详细的配置方法。
从 npm 上安装并使用 SDK 包
a. 安装
npm install minapp-sdk // npm
yarn add minapp-sdk // yarn
b. 构建 npm
c. 引入
// app.js
App({
onLaunch() {
// require SDK
require('minapp-sdk')
}
})
初始化 SDK
wx.BaaS.init(clientID, options)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
clientID | String | Y | 知晓云管理后台获取到的 ClientID |
options | InitOption | N | 其他选项 |
InitOption:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
autoLogin | Boolean | N | 请求知晓云接口时,是否自动静默登录,默认为 false |
logLevel | String | N | 日志输出级别,共支持 debug、info、warn、error 4 个级别,默认为 error |
host | String | N | 自定义域名 |
env | String | N | 开发环境 ID,用于区分生产环境与其他开发环境,默认为生产环境 |
关于 autoLogin 参数,具体请参考多平台用户统一登录 和 迁移指南。
clientID 在知晓云管理后台获取。
通过初始化 SDK ,知晓云服务可以验证当前的小程序是否是有效合法的,只有通过验证的小程序才能使用 SDK 提供的全部功能。
在知晓云后台 - 我的应用页面获取要接入知晓云服务的小程序 ClientID, 按照如下方式进行 SDK 初始化:
// app.js
App({
onLaunch() {
// 引入 SDK
require('minapp-sdk')
let clientID = '[[client_id]]'
wx.BaaS.init(clientID)
}
})
完成服务器域名配置
在这里可查看详细的配置方法。
使用 SDK
通过 wx.BaaS.init(clientID)
成功初始化 SDK 后,即可使用 SDK 完成数据操作,内容操作等功能了。如下,在控制台创建一张表(参考控制台操作-数据表 一节),获取其 tableName ,并插入一条数据。
let tableName = 'product'
let Product = new wx.BaaS.TableObject(tableName)
let product = Product.create()
let apple = {
name: 'apple',
price: 1,
desc: ['good'],
amount: 0
}
product.set(apple).save().then(res => {
console.log('成功插入数据:', res)
}, err => {
// err
})
更多内容,可查看以下功能模块介绍: