入驻【集简云开发者平台】，SDK嵌入接口文档介绍

集简云-软件连接神器

于 2022-07-23 11:00:00 发布

阅读量377

点赞数

文章标签： java http 开发语言

本文链接：https://blog.csdn.net/weixin_49220773/article/details/125853128

版权

开发指南

开发前必读

SDK嵌入方案需要先经过审核后方可使用。可联系集简云平台工作人员

开发文档阅读说明

所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。接口说明格式如下：

请求方式：GET/POST（HTTPS）
请求地址：https://developer.jijyun.cn/api/sdk/corp_token
请求包体：
...
参数说明：
...
权限说明：
...
返回结果：
...
参数说明：
...

请求方式，标明接口调用的HTTP方法，区分HttpGet/HttpPost请求。所有的请求都为https协议。
请求包体/参数说明，标明请求参数示例及说明，参数说明包括字段含义、取值范围，开发者在设计数据结构时，应参考该定义范围。
权限说明，标明接口的使用范围。
返回结果/参数说明，标明返回参数示例及说明。所有接口返回包里都有code、msg。开发者需根据code是否为0判断是否调用成功。

基本概念介绍

术语介绍

corp_id

嵌入方身份标识。获取此信息可在集简云开发者平台“API授权”可查看。

secret

嵌入方API调用凭据。获取此信息可在集简云开发者平台“API授权”可查看。

接口公共参数

timestamp： 当前时间戳（秒）。

sign：签名字段。

签名规则：

请求参数（除sign, secret以外）按照ASCII码表的顺序排序;

生成加排序串（如key1=value1&key2=value2），去除value无效的key;

然后secret拼接（secretkey1=value1&key2=value2）;

对加密字符串进行MD5。

签名示例：

请求参数：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1646740242,
    "company_identification": "test",
    "company_name": "test",
    "company_users": [
        {
            "user_name": "张三",
            "mobile": "15888888888",
            "email": "zhangsan@test.com",
            "isAdmin":0
        },
        {
            "user_name": "李四",
            "mobile": "15888888888",
            "email": "lisi@test.com",
            "isAdmin":1
        }
    ]
}

排序串：

company_identification=test&company_name=test&company_users=[{"user_name":"张三","mobile":"15888888888","email":"zhangsan@test.com","isAdmin":0},{"user_name":"李四","mobile":"15888888888","email":"lisi@test.com","isAdmin":1}]&corp_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&corp_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&timestamp=1646740242

拼接secret：

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcompany_identification=test&company_name=test&company_users=[{"user_name":"张三","mobile":"15888888888","email":"zhangsan@test.com","isAdmin":0},{"user_name":"李四","mobile":"15888888888","email":"lisi@test.com","isAdmin":1}]&corp_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&corp_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&timestamp=1646740242

进行MD5：

md5('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcompany_identification=test&company_name=test&company_users=[{"user_name":"张三","mobile":"15888888888","email":"zhangsan@test.com","isAdmin":0},{"user_name":"李四","mobile":"15888888888","email":"lisi@test.com","isAdmin":1}]&corp_id=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&corp_token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&timestamp=1646740242')

授权接口

获取企业访问凭证corp_token

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/corp_token

请求包体：

{
	"timestamp":1647500265,
	"corp_id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"sign":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
  "msg": "成功",
  "code": 0,
  "data": {
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "expires_in": 7200
  }
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
corp_token	是	企业访问接口凭证。
expires_in	是	接口凭证有效期。

获取用户访问凭证user_token

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/user_token

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_identification": "abcb",
    "user_email":"xxxxxx@test.com",
    "user_mobile":"151xxxxxxxx",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识
user_email	否	用户邮箱。user_email、user_mobile二选一
user_mobile	否	用户手机号。user_email、user_mobile二选一

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "data": {
        "company_id": "wd8072",
        "corp_name": "xxx",
        "email": "",
        "expire_time": 1650270921,
        "has_process": false,
        "mobile": "151xxxxxxxx",
        "open_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "token": "153c883239b88d2d3d807f1de59db4f2",
        "uid": "ey5481io",
        "uname": "sk"
    },
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
company_id	是	企业（集简云）唯一标识
corp_name	是	企业（集简云）名称
email	是	用户邮箱
expire_time	是	token过期时间。
has_process	是	是否创建过流程。
mobile	是	用户手机号
open_id	是	用户绑定微信open_id
token	是	用户（集简云）访问凭证
uid	是	用户（集简云）唯一标识
uname	是	用户（集简云）名称

企业成员接口

请求开通企业

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/create_company

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_info": {
        "company_name": "test",
        "company_identification": "abc"
    },
    "company_users": [
        {
            "user_name": "test",
            "mobile": "151xxxxxxxx",
            "email": "xxx@test.com",
            "isAdmin":0,
            "user_identify":"xxxxxxxx"
        },
        {
            "user_name": "test2",
            "mobile": "158xxxxxxxx",
            "email": "xxx@test.com",
            "isAdmin":1,
            "user_identify":"xxxxxxxx"
        }
    ],
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识
company_name	是	客户（嵌入方的）名称
email	否	用户邮箱
mobile	否	用户手机号
user_name	是	用户（集简云）名称
user_identify	是	用户唯一识别ID
isAdmin	是	是否是管理员。1管理员，否则成员

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码

新增用户到企业

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/create_user

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_identification": "abcb",
    "company_users": [
        {
            "user_name": "test",
            "mobile": "151xxxxxxxx",
            "email": "xxx@test.com",
            "isAdmin":0,
            "user_identify":"xxxxxxxx"
        },
        {
            "user_name": "test2",
            "mobile": "158xxxxxxxx",
            "email": "xxx@test.com",
            "isAdmin":1,
            "user_identify":"xxxxxxxx"
        }
    ],
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识
email	否	用户邮箱
mobile	否	用户手机号
user_name	是	用户（集简云）名称
user_identify	是	用户唯一识别ID
isAdmin	是	是否是管理员。1管理员，否则成员。

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码

查询企业内成员

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/query_user

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_identification": "abcb",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "data": [
        {
            "email": "test@test.com",
            "mobile": "18718920924",
            "role_name": "成员",
            "state": 1,
            "user_name": "test",
            "user_identify":"xxxxxxxx"
        },
        {
            "email": "156369902@qq.com",
            "mobile": "15122884144",
            "role_name": "管理员",
            "state": 1,
            "user_name": "sk",
            "user_identify":"xxxxxxxx"
        }
    ],
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
email	是	用户邮箱
mobile	是	用户手机号
user_name	是	用户（集简云）名称
role_name	是	角色名称
state	是	用户状态。1有效，否则无效
user_identify	是	用户唯一识别

修改成员

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/modify_user

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_identification": "abcb",
    "user_email":"test@test.com",
    "user_mobile":"15122884144",
    "user_identify":"xxxxxxxx",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识
user_email	否	用户邮箱
user_mobile	否	用户手机号
user_identify	是	用户唯一识别

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码

账户相关接口

查询嵌入方余额

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/query_balance

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "data": "1000.00",
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
data	是	余额

查询指定企业使用量与余额

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/query_company_balance

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_identification": "abcb",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "data": [
        {
            "amount": 500,
            "product_name": "免费版本",
            "remaining_amount": 500
        }
    ],
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
amount	是	流程最大总执行次数
product_name	是	产品版本
remaining_amount	是	剩余执行次数

查询指定企业付费版本

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/query_company_quota

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "company_identification": "abcb",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
company_identification	是	客户（嵌入方的）身份唯一标识

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
  "Code": 2000,
  "Msg": "成功！",
  "Data": [
    {
      "balance": 7700.04,
      "Data": [
        {
          "product_name": "可创建最大流程数",
          "payment": 0,
          "amount": 4,
          "remaining_amount": 4,
          "explain": ""
        },
        {
          "product_name": "单流程最大步骤",
          "payment": 0,
          "amount": 10,
          "remaining_amount": "-",
          "explain": "每个数据流程中可以使用的最大应用数量"
        },
        {
          "product_name": "付费应用",
          "payment": 0,
          "amount": 0,
          "remaining_amount": "-",
          "explain": ""
        },
        {
          "product_name": "每月流程最大总执行次数",
          "payment": 0,
          "amount": 500,
          "remaining_amount": 0,
          "explain": "每月赠送500次免费调用，次月刷新余量不累计"
        }
      ]
    }
  ]
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
balance	是	余额
product_name	否	产品名称
payment	否	是否付费。0否
amount	否	总数
remaining_amount	否	剩余
explain	否	备注

其他配置

获取个性化设置

请求方式：POST（HTTPS）

请求地址：https://developer.jijyun.cn/api/sdk/get_page_cfg

请求包体：

{
    "corp_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "corp_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "timestamp": 1647500265,
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"cfg_id": "0421d510-b885-11ec-b5ff-7579a1a32aea"
}

参数说明：


参数	必须	说明
timestamp	是	当前时间戳(timestamp)（秒）
corp_token	是	嵌入方访问凭证（参考《获取企业访问凭证》接口）
corp_id	是	嵌入方唯一标识(corp_id)
sign	是	签名。见接口公共参数
page_id	是	获取嵌入页面配置信息。开发者平台-嵌入方案-页面代码生成器获取。

权限说明：

仅开通嵌入功能的企业可调用。

返回结果：

{
    "code": 0,
    "data": {
        "appShowNum": 10,
        "company_id": "pc1265",
        "connectApp": {
            "appId": 76,
            "appName": "Excel 365",
            "category": "工具软件",
            "iconUrl": " https://downloads-51growth.oss-cn-beijing.aliyuncs.com/assets/img/apps/excel-365.svg",
            "version": null
        },
        "endAppLabel": "与这个应用软件",
        "excludeApps": [],
        "excludeCategory": [],
        "includeCategory": [],
        "isShowAppSearch": true,
        "isShowIntro": true,
        "isShowTitle": true,
        "openPageType": "新窗口打开",
        "pageIntro": "功能介绍",
        "pageIntroDesc1": "在不编写代码的情况下自动化重复任务",
        "pageIntroDesc2": "构建自定义构件来节省时间",
        "pageIntroDesc3": "连接1234等多个你已经在使用的应用程序",
        "pageIntroDesc4": "核心功能永久免费：高级功能免费试用14天",
        "pageSubTitle": "The App Directory below has a transparent background.",
        "pageTitle": "应用目录",
        "page_uuid": "0421d510-b885-11ec-b5ff-7579a1a32eaa",
        "startAppLabel": "连接这个应用程序...",
    },
    "msg": "成功"
}

参数说明：


参数	必须	说明
msg	是	对返回码的文本描述内容
code	是	返回码
appShowNum	是	应用显示数量
company_id	是	企业（集简云）标识
connectApp_appId	是	链接应用唯一标识
connectApp_appName	是	链接应用名称
connectApp_category	是	链接应用所属分类
connectApp_iconUrl	是	链接应用icon链接
connectApp_version	是	链接应用版本
endAppLabel	是	被链接应用搜索label
excludeApps	是	排除应用
excludeCategory	是	排除分类
includeCategory	是	包含分类
isShowAppSearch	是	是否显示应用搜索
isShowIntro	是	是否显示功能介绍
isShowTitle	是	是否显示标题
openPageType	是	页面打开方式
pageIntro	是	功能介绍
pageIntroDesc1	是	功能介绍详细1
pageIntroDesc2	是	功能介绍详细2
pageIntroDesc3	是	功能介绍详细3
pageIntroDesc4	是	功能介绍详细4
pageSubTitle	是	页面子标题
pageTitle	是	页面标题页面
startAppLabel	是	链接应用搜索label