开发指南

开发前必读

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

开发文档阅读说明



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

请求方式:GET/POST(HTTPS)
请求地址:https://developer.jijyun.cn/api/sdk/corp_token
请求包体:
...
参数说明:
...
权限说明:
...
返回结果:
...
参数说明:
...
  1. 请求方式,标明接口调用的HTTP方法,区分HttpGet/HttpPost请求。所有的请求都为https协议。

  2. 请求包体/参数说明,标明请求参数示例及说明,参数说明包括字段含义、取值范围,开发者在设计数据结构时,应参考该定义范围。

  3. 权限说明,标明接口的使用范围。

  4. 返回结果/参数说明,标明返回参数示例及说明。所有接口返回包里都有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

入驻 【集简云开发者平台】,SDK嵌入接口文档介绍相关推荐

  1. 【分享】pushplus入驻集简云平台,实现无代码集成数百款应用

    集简云是一款超级软件连接器,通过集简云您无需任何开发就可以将pushplus系统与您在使用的内部与外部系统打通,例如CRM,数据库,邮件系统,短信系统,外呼电话系统,ERP财务系统等500多款软件系统 ...

  2. 【分享】快递100入驻集简云平台,实现无代码集成数百款应用

    快递100 快递100是中国领先的快递物流信息服务商,归属于金蝶国际软件集团,它是集快递单号查询.快递单号短信跟踪.快递网点查询.网上寄快递等为一体的综合性快递物流服务网站. 截至目前,快递100与全 ...

  3. HIFIVE音乐开放平台音乐api接口文档!

    HIFIVE拥有数百万正版音乐版权内容,可以通过api.Java/PHP/Python SDK.Android/iOS SDK 方式接入获取音乐,三十分钟即可快速集成上线. https://open. ...

  4. 亲测可用云e办项目的接口文档21年10月更新

    前言 一直想开发一个功能比较强大的项目,但是一直没有动手,最近终于有点时间来折腾它了.由于时隔两年没有接触前端了,所以需要一个小项目先练练手感.等这个项目完工之后在着手搞一个大工程.都说好记星不如烂笔 ...

  5. 集简云助力企业实现账务管理数智化,招银云直联无代码对接企业自研系统

    客户 · 介绍 成都环泰宏图科技公司是一家专注于新兴产业高端技术的研发.集成.推广.运维的高新技术企业.公司主要提供信息化.物联网.人工智能.智慧城市等高端技术领域的解决方案和服务,注重技术创新和技术 ...

  6. 集简云 x 度量科技丨打通企业微信OA审批与招银云直联,实现支付信息自动同步网银系统

    客户 · 介绍 北京度量科技有限公司专注于自主研发.生产制造和销售光学三维动作捕捉系统.公司现已获得专精特新企业.高新技术企业.瞪羚企业.展翼企业等一系列称号. 度量的核心产品--NOKOV(度量)光 ...

  7. 【分享】微信公众号在 “集简云平台“ 集成应用的常见问题与解决方案

    "function category of API need be confirmed by component rid"错误 是由于使用未认证的微信公众号或者个人微信公众号没有此 ...

  8. 【分享】“明道云“ 在集简云平台集成应用的常见问题与解决方案

    1.明道云授权不成功,提示验证失败 用户在授权时,需要复制Sign值,到集简云授权页面,在复制容易遗漏==,一定要复制全,不然会提示授权失败. 2.明道云常见问题 1)应用接入和网站接入的区别? 应用 ...

  9. 【分享】“飞书自建“在集简云平台集成应用的常见问题与解决方案

    一.通讯录动作常见问题 1.通讯录动作出现错误了怎么办? 如果遇到"通讯录动作"出现问题,请点击以下链接,参考[通讯录常见问题]相关文档 [通讯录常见问题]文档:开发文档 - 飞书 ...

最新文章

  1. dwa的区别 teb_teb_local_planner安装及使用
  2. 以及其任何超类对此上下文都是未知的_ECCV'20 |OCRNet化解语义分割上下文信息缺失难题...
  3. WebRTC 视频发送和接收处理过程
  4. 机器人的艺术,是什么样子的?
  5. 8 | Spatial-based GNN/convolution模型之GAT(受欢迎)
  6. 基于visual Studio2013解决面试题之0707最小元素
  7. PHP substr(),mb_substr(),mb_strcut()比较
  8. [Icehouse][cinder] volume状态为 error_deleting无法删除 的解决方案
  9. 兄弟打印机内存已满清零方法_brother打印机怎么清零?brother打印机清零方法
  10. STEP 7 MicroWin SP9 帮助文档修复
  11. 超级好用的画图吸色工具FastSton Capture
  12. 校园网网络命令拓扑命令+详解集合
  13. docker下编译mangoszero WOW60级服务端(一)
  14. 新技术在支付清算行业的创新应用
  15. 切换无线网卡失败服务器提示,无线网卡切换为AP模式时提示ICS启动失败的解决方法...
  16. 软件项目延期,怎么办?
  17. 记一次面试准备(续上)
  18. 2022-2023年度第四届全国大学生算法设计与编程挑战赛(秋季赛)【热身赛】h-4题 花灯
  19. Linux入门学习日志(三)
  20. queued_在Linux上,诸如“ UnrecovData 10B8B BadCRC”和“失败的命令:READ FPDMA QUEUED”之类的消息有什么问题?...

热门文章

  1. jupyter notebook环境配置(重写config文件、配置默认工作文件路径、如何解决需要token登陆的问题/解决无法跳转浏览器问题等)
  2. 用Python找101-200之间的素数
  3. 求N个数的最大公约数和最小公倍数以及Hankson逆问题(python)
  4. 滚轮每次滚动距离是一致的吗_「超硬核科普」鼠标的发展历史,中国人发明的鼠标滚轮...
  5. 应届生什么专业方向就业面广?
  6. 免费免安装!3s 获取云数据库,MySQL,Mongo、Redis 全都有!
  7. 怎样删除androidstudio创建的模拟器
  8. 1090 Highest Price in Supply Chain(天上人间,潇潇共雨。曼珠红遍,流水忘川。)
  9. 信息传输速率与传信率_波特率和数据传输速率的关系
  10. 2021年全球医药电子商务行业调研及趋势分析报告