入驻 【集简云开发者平台】，SDK嵌入方案介绍

1 什么是SDK嵌入方案

SDK嵌入方案可以将集简云的产品功能嵌入到我们自己的产品内，为我们的用户提供集简云的功能。用户体系通过接口打通，用户无需注册或者登录集简云使用。

示例：集简云SDK嵌入到WordPress中：



 



2 SDK嵌入方案的功能

• 快速在我们的现有产品中增加集简云相关功能

• 用户体系打通，用户无需注册和登录集简云账户

• 自定义页面样式，包括应用列表选择，文案，样式，应用模板个性化展现等

• 自定义产品版本，可以制定个性化产品版本和价格进行售卖，增加我们的产品收入

• 客户管理后台，我们可以查看我们客户的流程使用量等数据，进行调整客户的版本等多种操作



3 SDK嵌入方案的使用步骤：

3.1 申请SDK嵌入方案权限

SDK嵌入方案的API权限需要单独进行申请，可与集简云工作人员联系



3.2 使用流程

SDK嵌入提供了简单的方式，嵌入方仅需要在前端引用 jijyunConnect 即可使用



 



3.2.1 安装SDK

# 通过 npm
npm install jijyun-js-sdk

# 通过 yarn
yarn add jijyun-js-sdk

3.2.2 初始化iframe

const { jijyunConnect } = window.JijyunJSSDK

jijyunConnect({
  secret:'企业密匙',//从集简云开发者平台获取
  corp_id:'企业ID',//从集简云开发者平台获取
  //company_name:'注册企业名称',
  company_identification:'企业标识',
  //user_name:'注册企业用户名',
  user_identify:'用户识别码',//用户唯一识别码ID
  //user_mobile:'手机号码',
  //user_email:'邮箱',
  //user_isAdmin:'是否为管理员',//1：管理员，其他为否
  cfg_id:'页面配置',//页面配置
  //domain:'安全域名',//您的域名白名单，可省略
  src: '集简云sdk地址',
  pageType:'data-pipeline',//pipeline-template（流程模板）、data-pipeline（数据流程）、data-log（流程日志）、app-manage（应用管理）
  container: document.querySelector('#jijyun_file') // iframe 挂载的目标容器元素
}).then((jijyunSDK) => {
  // ...
})

使用传统的 <script> 的方式加载：

<script src="https://cdn.jijyun.cn/t/site316/index-sdk.js"></script>

const { jijyunConnect  } = window.JijyunJSSDK
// 等价于
const { jijyunConnect  } = require('jijyun-js-sdk')

3.2.3 使用示例

const { jijyunConnect, pageType, getCorpToken, regCompany } = window.JijyunJSSDK

// pageType：pipeline-template（流程模板）、data-pipeline（数据流程）、data-log（流程日志）、app-manage（应用管理）

// getCorpToken(secret:string, corp_id:string, domain:string) 
// getCorpToken获取corp_token，可以在自己的后台请求接口（https://developer.jijyun.cn/api/sdk/corp_token）
// 或者前端请求获取getCorpToken得到corp_token，也可以从localStorage中获取（ localStorage.getItem('sdkCorptoken')）

// 执行注册企业
// regCompany(params) 函数是注册企业（需要corp_token）
// 也可以在自己的后台请求接口（https://developer.jijyun.cn/api/sdk/create_company），注册自己的企业

async function initJijyunSDK(){
  try {
    jijyunConnect({
      secret:'企业密匙',
      corp_id:'企业ID',
      company_identification:'企业标识',
      user_identify:'用户识别码',
      cfg_id:'页面配置',
      src: '集简云sdk地址',
      pageType:'pipeline-template',
      container: document.querySelector('#jijyun_file')
    }).then((jijyunSDK) => {
      console.log("jijyunSDK",jijyunSDK)
    })
  }catch(e) {
      console.log(e)
  }
}   
initJijyunSDK()

4 SDK后端接口

除了通过SDK展现页面以外，集简云还提供了多个后端接口，可以提供用户付费版本产品开通，新增用户信息/权限，修改用户信息权限，修改用户付费版本等功能，可登录集简云-开发者平台进行查看

5 SDK客户管理与产品售卖功能

在嵌入集简云产品后，我们可以使用将集简云功能作为我们产品的付费功能售卖给我们的用户，增加产品收入与客单价。 集简云提供了客户管理和产品（付费版本）管理功能。可登录集简云-开发者平台进行查看