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_identification:'企业标识', // 您的客户在您的系统中的企业ID,如果没有企业可以使用用户ID
user_identify:'用户识别码', // 您的客户在您的系统中用户ID
cfg_id:'页面配置', //个性化页面配置,在集简云开放平台中设置(https://open.jijyun.cn/embed/customepage)
pageType:'data-pipeline', // 集简云目前提供4个页面,选择不同参数可访问不同页面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:'页面配置'(在https://open.jijyun.cn/embed/customepage配置),
pageType:'pipeline-template',
container: document.querySelector('#jijyun_file')
}).then((jijyunSDK) => {
console.log("jijyunSDK",jijyunSDK)
})
}catch(e) {
console.log(e)
}
}
initJijyunSDK()
如果出现下面图片之一,说明已经注册并新建完成,您可以在系统中新建流程了
修改时间 1 年前