# 基本概念

# 应用操作

应用操作模块是关于应用的一些接口及如何进行相关操作的说明,例如开启应用,关闭应用,应用监控等接口以及如何进行应用跳转,管理应用后台,和统计应用。

# 身份验证

身份验证模块是分PC端和移动端获取用户身份。获取用户身份又分为三种:

1.移动端H5获取用户身份

2.移动端小程序获取用户身份

3.PC端获取用户身份态

# 电子码

电子码模块分为两个部分,关于如果进行电子码解码和电子码时间的回调。提供的接口有:

1.电子码解码

2.电子码事件回调

# 主体信息管理

主体信息管理模块是需要拿到应用有效凭证,然后根据有效凭证再去相关接口获取自己所需的信息。提供的接口有:

1.获取主体基本信息

2.获取组织架构

3.获取组织架构类型

4.获取组织架构变更事件推送

5.获取单个组织架构成员

6.获取成员身份类型

7.搜索成员

8.成员变更事件推送

9.获取权限组

10.获取权限组详情

11.获取用户权限信息

# 消息通知

消息通知模块主要是一些关于消息通知的接口说明。提供的接口有:

1.查询通知能力

2.发送通知

3.通知数据明细

4.用户阅读通知情况

# 电子卡

电子卡模块主要是一些小程序与电子卡之间一些操作的接口说明。提供的接口有:

1.小程序打开电子卡

2.小程序添加电子卡

3.电子卡跳转小程序获取成员信息

# 相关工具

相关工具模块主要是一些方便开发的工具类,应用的demo,加解密的demo,还有接口签名用到的签名算法。还有两个验证工具,签名验证工具和接口验证工具。

1.DEMO下载

2.加解密

3.签名算法

4.签名验证工具 (opens new window)

5.接口验证工具 (opens new window)

# 全局说明

1,本文档使用的应用启用地址:

https://www.example.com/index

2,应用接口类型说明:

为了便于管理,收拢应用接口地址。

应用接口类型地址 用途
https://www.example.com/index?type=open 开启应用
https://www.example.com/index?type=close 关闭应用
https://www.example.com/index?type=trigger H5应用跳转
https://www.example.com/index?type=manage 应用管理后台
https://www.example.com/index?type=monitor 应用监控

3,学校/企业信息接口说明:

获取管理员信息:为统一腾讯微卡平台和应用管理后台的用户体系,该接口可供腾讯微卡平台管理员信息获取

获取学校/企业信息:只有学校/企业对应用处于开启状态时,接口才允许调用

4,本文档使用的AppKey和AppSecret如下:

AppKey: BE30B2BA30ABFADB

AppSecret: CF8CDD8D0B7B1ACDA76201F406BED81E

实际AppKey(16位)和AppSecret(32位)由腾讯微卡提供。