知晓云 JS SDK

简介

知晓云 JS SDK 是方便开发者结合知晓云产品，进行小程序开发的工具包，通过该 SDK，你可以在小程序中操作存储在知晓云中的数据表、内容库、媒体文件，及方便地调用微信登录，微信支付，发送模板消息等功能。

引入 SDK 并初始化

使用知晓云 SDK 小程序插件，相对于引入 SDK js 文件方式，省去了下载 SDK 文件和配置服务器域名操作，同时可以更加方便的切换不同版本的 SDK。

添加知晓云 SDK 小程序插件

在小程序的管理后台【设置】-【第三方服务】-【插件管理】中添加插件，根据知晓云 SDK 小程序插件的 AppID 「wxc6b86e382a1e3294」搜索到我们的插件，添加后等待审核，审核通过即可使用。

在项目配置中声明使用知晓云 SDK 小程序插件

插件版 sdk 1.5.1 以上需小程序基础库 2.1.0 及以上。

在项目的配置文件 app.json 中对插件进行引入声明：

  2. {"plugins": {
  3.   "sdkPlugin": {
  4.     "version": "1.16.0",
  5.     "provider": "wxc6b86e382a1e3294"
  6.   }
  7. }}
  8.  

目前知晓云 SDK 小程序插件提供如下版本：

插件版 SDK 版本对应 js 文件版 SDK 版本
0.1.0v1.2.0
1.3.0 及之后与文件版的版本号同步

初始化 SDK

通过初始化 SDK ，知晓云服务可以验证当前的小程序是否是有效合法的，只有通过验证的小程序才能使用 SDK 提供的全部功能。

在知晓云后台 - 我的应用页面获取要接入知晓云服务的小程序 ClientID, 按照如下方式进行 SDK 初始化:

  1. //app.js
  2. App({
  3.   onLaunch: function() {
  4.     wx.BaaS = requirePlugin('sdkPlugin')
  5.     //让插件帮助完成登录、支付等功能
  6.     wx.BaaS.wxExtend(wx.login, wx.getUserInfo, wx.requestPayment)
  8.     let clientID = '知晓云管理后台获取到的 ClientID'
  9.     wx.BaaS.init(clientID)
  10.   }
  11. })

下载并导入 SDK

a. 下载最新版 SDK 到本地

b. 将下载解压后得到的 SDK js 文件放在小程序项目目录中

  2. // app.js
  4. App({
  5.   onLaunch() {
  6.     // require SDK
  7.     require('./sdk-v1.16.0')
  8.   }
  9. })
  10.  

初始化 SDK

通过初始化 SDK ，知晓云服务可以验证当前的小程序是否是有效合法的，只有通过验证的小程序才能使用 SDK 提供的全部功能。

在知晓云后台 - 我的应用页面获取要接入知晓云服务的小程序 ClientID, 按照如下方式进行 SDK 初始化:

  2. // app.js
  4. App({
  5.   onLaunch() {
  6.     // 引入 SDK
  7.     require('./sdk-v1.16.0')
  8.      let clientID = '知晓云管理后台获取到的 ClientID'
  9.      wx.BaaS.init(clientID)
  10.   }
  11. })
  12.  

完成服务器域名配置

在这里可查看详细的配置方法。

从 npm 上安装并使用 SDK 包

a. 安装

  1. npm install minapp-sdk  // npm
  2. yarn add minapp-sdk  // yarn

b. 构建 npm

c. 引入

  1. // app.js
  3. App({
  4.   onLaunch() {
  5.     // require SDK
  6.     require('minapp-sdk')
  7.   }
  8. })

初始化 SDK

通过初始化 SDK ，知晓云服务可以验证当前的小程序是否是有效合法的，只有通过验证的小程序才能使用 SDK 提供的全部功能。

在知晓云后台 - 我的应用页面获取要接入知晓云服务的小程序 ClientID, 按照如下方式进行 SDK 初始化:

  1. // app.js
  3. App({
  4.   onLaunch() {
  5.     // 引入 SDK
  6.     require('minapp-sdk')
  7.     let clientID = '知晓云管理后台获取到的 ClientID'
  8.     wx.BaaS.init(clientID)
  9.   }
  10. })

完成服务器域名配置

在这里可查看详细的配置方法。

使用 SDK

成功初始化 SDK 后，即可使用 SDK 完成数据操作，内容操作等功能了。如下，在控制台创建一张表（参考控制台操作-数据表 一节），获取其 tableID ，并插入一条数据。

  1. let tableID = 10
  2. let Product = new wx.BaaS.TableObject(tableID)
  3. let product = Product.create()
  5. let apple = {
  6.   name: 'apple',
  7.   price: 1,
  8.   desc: ['good'],
  9.   amount: 0
  10. }
  12. product.set(apple).save().then(res => {
  13.   console.log('成功插入数据：', res)
  14. }, err => {
  15.   // err
  16. })

更多内容，可查看以下功能模块介绍：