龙岩市教育公共服务平台

服务中心

>网站首页>对接文档>内容详情

龙岩市教育数据共享服务平台-天喻认证相关接口

发布时间: 2022-10-12 11:01 发布单位: 龙岩市教育局云管中心 浏览量: 3025 【公开】

 

 

【龙岩市教育数据共享服务平台】

教师机构员信息接口

(版本号 V1.1

 

 

文档修订记录

版本号

状态

简要说明

日期

变更人

V1.0

建立

教师机构人员信息获取接口

2022.5.24

童倩

V1.1

新增

组织机构和机构管理员接口

2022.6.9

童倩

 

 

 

 

 

 

 

 

 

 

1       接口服务规范

1.1、接口说明

龙岩市教育数据共享服务平台在政务信息网和政务外网、互联网区提供Restful接口,各部门业务系统通过调用该Restful接口,实现政务数据实时共享

1.2、使用约束

限制类型

限制说明

传输字符编码格式

平台接口采用的是UTF-8编码格式

传输数据格式

平台接口采用JSON格式

 

1.3、接口原则

为了保证汇聚共享平台对外提供的统一接口安全可靠、简易兼容,接口规范应满足如下原则:

(1)            接口具有普遍的适应性;

(2)            使用简单、快捷的方式实现其他系统的接入;

(3)            接口应充分考虑省汇聚共享平台的应用扩展情况;

(4)            保证接口数据在省汇聚平台与用户系统的一致性;

(5)            接口调用能够方便的形成,并能在接入方顺利地实现;

(6)            在满足功能要求的前提下,使接口数据量最少;

(7)            接口数据传输控制策略可靠且完善;

(8)            具有可靠的接口数据出错返回机制。

 

2      接口使用规范

 

2.1、通用规范

2.1.1协议

所有接口调用均采用HTTP远程调用方式,客户端调用并同步返回响应。数据格式: json

2.1.2 请求

1. 请求方式:get/post, 服务地址url格式为http://domain/[service]/[servicename]

其中:domain为服务域名、service为服务名称、servicename 为API名称.

2. 协议消息头包含以下属性:

Content-Type:application/json;charset=utf-8;

3. 请求header包含以下参数:

user-date: 调用日期。格式yyyyMMddHHmmssSSS。17位日期字符串,小时采用24小时格式,如:20160101160758675;

user-params:请求参数。Get请求格式为:xx=xx&xx=xx。Post请求格式为json字符串。并对参数进行URL的UTF-8编码

authorization: 鉴权码,其中,鉴权码(authorition)=dc:{apikey}:{signature}。鉴权码由三部分组成,他们之间以英文冒号隔开;(详细请参考2.2)

2.1.3 响应

1. 响应报文媒体类型为application/json;charset=utf-8.

2.2、鉴权信息

apikey

管理人员分配

secretkey

管理人员分配

 

 

 

 

authorization:

第一部分:固定值为dc。

第二部分:用户申请的apikey。

第三部分:数据签名(signature)。

例如:

dc:test-apikey:ODExQUJENUFCRTBDQTc5NzM4RkQ2RTUzQzE2MDQyNUY=

数据签名(signature),加密格式如下:

signature=

BASE64{

Hmac_sha1{

user-params + 换行符

+ user-date + 换行符

}

}

数据签名由hmac_sha1加密后在经base64编码。hmac_sha1密钥为用户申请的secretkey。}

 

user-date

用日期。格式yyyyMMddHHmmssSSS。17位日期字符串,小时采用24小时格式,如:20160101160758675;

 

user-params

请求参数。Get请求格式为:xx=xx&xx=xx。Post请求格式为json字符串。

并对参数进行URL的UTF-8编码

2.3API接口调用示例

API调用示例代码:

下载Api调用示例,把代码导入开发工具,查看其中的RequestApiTest类,修改其中的 APIKEY,SECRETKEY,然后根据相应的请求方式,修改接口地址进行测试。

 

 

3       接口清单

3.1教师机构人员信息

接口访问地址

http://http://open-api.longyanedu.net/teacherStaffInfo/teacherStaffList

接口方式

HTTP

提交方式

get

入参

名称

必填

数据类型

说明

update_time

string

更新时间(如:20220524121212

card_code

string

身份证号码

phone

string

联系方式

org_id

string

机构id

name

string

姓名

user_type

string

用户类型

教育局机构:4机构人员;

学校:1老师、3工作人员

 

 

status

string

用户状态

admin_type

string

管理员类型(1:主管理员,2:子管理员)

pageNum

Int

页码

pageSize

int

每页大小

出参

名称

数据类型

说明

errCode

String

结果编码,000000:成功

message

String

结果描述

请求示例

update_time='20220524121212'

返回示例

{"errCode":"000000","msg":"Successed","data":{"totalNum":21,"currentPage":1,"records":[{"subject_id":"","card_code":"350823199505176124","birthdate":0,"gender":false,"area_code":"350823","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"","update_time":"20220523155031","user_type":1,"phone":"","org_id":"05775b2e7feb11ec94a50236fa39e89f","nick_name":"吴春红","subject_period":"","name":"吴春红","org_name":"上杭县育才幼儿园(西二环园)","account":"do105405,350823199505176124","status":false},{"subject_id":"jcsub03","card_code":"350429198712092021","birthdate":0,"gender":false,"area_code":"","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"0","update_time":"20220523174820","user_type":1,"phone":"13950819849","org_id":"d5a9b9fb5d0e435b89c53b239480f98f","nick_name":"黄裕","subject_period":"0","name":"黄裕","org_name":"龙岩市万安中心小学","account":"350429198712092021,3577707699,13950819849","status":true},{"subject_id":"","card_code":"352624197105283746","birthdate":0,"gender":false,"area_code":"350823","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"","update_time":"20220523185642","user_type":3,"phone":"18860151748","org_id":"36a777f932d6491b8c32833a3d7ba793","nick_name":"黄翠玉","subject_period":"","name":"黄翠玉","org_name":"上杭县南阳镇豪东小学","account":"ah388486,18860151748,352624197105283746","status":false},{"subject_id":"","card_code":"35262419801216374X","birthdate":0,"gender":false,"area_code":"350823","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"","update_time":"20220523185707","user_type":3,"phone":"15159090391","org_id":"36a777f932d6491b8c32833a3d7ba793","nick_name":"梁玉英","subject_period":"","name":"梁玉英","org_name":"上杭县南阳镇豪东小学","account":"tk856998,15159090391,35262419801216374X","status":false},{"subject_id":"","card_code":"350823199510164224","birthdate":0,"gender":false,"area_code":"350823","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"","update_time":"20220523155122","user_type":1,"phone":"","org_id":"05775b2e7feb11ec94a50236fa39e89f","nick_name":"王永香","subject_period":"","name":"王永香","org_name":"上杭县育才幼儿园(西二环园)","account":"hu891095,350823199510164224","status":false},{"subject_id":"jcsub03","card_code":"350822198710134424","birthdate":0,"gender":false,"area_code":"","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"18250112985","update_time":"20220523145915","user_type":1,"phone":"18250112985","org_id":"6de7b0b4dc824195b850c94a1b19ae0b","nick_name":"苏晓珊","subject_period":"0","name":"苏晓珊","org_name":"西陂园田塘小学","account":"tb239728,350822198710134424,18250112985","status":true},{"subject_id":"jcsub02","card_code":"430425198307080785","birthdate":0,"gender":false,"area_code":"","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"18559737476","update_time":"20220523160817","user_type":1,"phone":"18559737476","org_id":"6de7b0b4dc824195b850c94a1b19ae0b","nick_name":"王青艳","subject_period":"0","name":"王青艳","org_name":"西陂园田塘小学","account":"qq792774,430425198307080785,18559737476","status":true},{"subject_id":"","card_code":"35262419810312552X","birthdate":0,"gender":false,"area_code":"350823","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"","update_time":"20220523155153","user_type":1,"phone":"","org_id":"05775b2e7feb11ec94a50236fa39e89f","nick_name":"张晓兰","subject_period":"","name":"张晓兰","org_name":"上杭县育才幼儿园(西二环园)","account":"qc585944,35262419810312552X","status":false},{"subject_id":"jcsub02","card_code":"350821198910123707","birthdate":0,"gender":false,"area_code":"","city_code":"350800","avatar":"https://uc-1256736654.cos.ap-shanghai.myqcloud.com/350800/uploads/avatar/local/data/33/40/99a6cb64b851420b97be4d20440126c1_180x180.jpg","province_code":"350000","card_type":false,"wechat_no":"15880772637","update_time":"20220523170424","user_type":1,"phone":"15880772637","org_id":"5b5f322bc08549e59b1ba56cbbe97171","nick_name":"涂满香","subject_period":"0","name":"涂满香","org_name":"龙岩市小池中心小学","account":"350821198910123707,3511638603,15880772637","status":true},{"subject_id":"jcsub11","card_code":"352601197606144512","birthdate":203529600,"gender":true,"area_code":"350802","city_code":"350800","avatar":"","province_code":"350000","card_type":false,"wechat_no":"","update_time":"20220523173449","user_type":1,"phone":"","org_id":"5f1be054f67944bdbd11bb061822278a","nick_name":"张锦强","subject_period":"1","name":"张锦强","org_name":"龙岩莲东中学","account":"352601197606144512,sq181309","status":true}]}}

 

返回说明

序号

字段

说明

1

nick_name

昵称

 

user_id

用户id

 

admin_type

管理员类型(1:主管理员,2:子管理,非管理员字段为空)

2

province_code

省编码

3

wechat_no

微信号

4

birthdate

生日

5

name

姓名

6

user_type

用户类型

7

card_type

身份证类型

8

area_code

区县编码

9

org_id

机构id,多个逗号隔开

10

org_name

机构名称,多个逗号隔开

11

subject_period

学期

12

phone

电话

13

update_time

更新时间

14

city_code

市编码

15

gender

性别

16

account

账号,多个逗号隔开

17

status

状态

18

subject_id

任教学科

19

avatar

头像

20

card_code

身份证号

 

 

org_code

机构编码








3.2组织机构(天喻库获取

接口访问地址

http://http://open-api.longyanedu.net/platform/getOrgList

接口方式

HTTP

提交方式

post

入参

名称

必填

数据类型

说明

orgTypes

String[]

机构类型。1: 机构,2: 学校,3:校区,4: 部门,5: 学段,6: 年级,7:班级,8: 企业机构,9: 教学工作室,10: 平台

pageNum

Int

页码

pageSize

int

每页大小

出参

名称

数据类型

说明

errCode

String

结果编码,000000:成功

message

String

结果描述

result

String

返回内容

请求示例

{"orgTypes":["1","4"],"pageSize":5}

返回示例

{"code":"000000","message":"success","result":{"page":{"startIndex":0,"totalPage":3645,"currentPage":1,"totalSize":18222,"pageSize":5},"list":[{"org_parent_id":"097dcd3d511847289eb4d12ef54256f3","org_id":"00014a927feb11ec94a50236fa39e89f","org_short_name":"上杭县通贤镇东里幼儿园","area_code":"350823","org_type":2,"city_code":"350800","attribute":"{"org_level": "4", "org_coding": "1135001027", "org_address": "", "org_category": "12", "org_parent_id": "097dcd3d511847289eb4d12ef54256f3", "org_telephone": "/pvnVnvQ8upvjYEoDoyBlA==", "org_level_code": "350823", "org_parent_ids": "[\"9d7153f90fe8450abbd2635027f627dc\",\"097dcd3d511847289eb4d12ef54256f3\"]", "org_website_close": "0", "org_create_user_close": "0", "org_member_default_pw": "vhzv5BWGx+6HHHweTi1fXg==", "school_group_admin_id": "", "org_invite_member_join": "1", "school_group_admin_status": "0"}","org_name":"上杭县通贤镇东里幼儿园","province_code":"350000","status":1,"certification":true},{"org_parent_id":null,"org_id":"0002d834d7e911ecb5c40256ab052474","org_short_name":"","area_code":"","org_type":4,"city_code":"","attribute":"{"org_coding": "f3aan4pk", "auto_create_group": "0", "auto_create_wps_group": "0"}","org_name":"政史地教研组","province_code":"","status":1,"certification":false},{"org_parent_id":null,"org_id":"000478b4c6c911ecb9b5a2aa5f9415ff","org_short_name":"","area_code":"","org_type":7,"city_code":"","attribute":"{"grade_year": "2019", "org_coding": "kv8n67f6", "period_type": "5", "class_number": "21", "grade_number": "3", "grade_system": "system_5_3", "graduation_year": "2022", "grade_rule_number": "3", "school_class_header_teacher_ids": "bef6c74334b541178c91b69d4505946b"}","org_name":"2019级三年制21","province_code":"","status":1,"certification":false},{"org_parent_id":null,"org_id":"00057071e5e641f786108a856d79c766","org_short_name":"二年级5","area_code":"","org_type":7,"city_code":"","attribute":"{"grade_year": "2020", "org_coding": "72g25oy4", "period_type": "0", "class_number": "5", "grade_number": "2", "grade_system": "system_0_63", "graduation_year": "2026", "grade_rule_number": "2", "school_class_header_teacher_ids": "aa667092a45c4a428f70f1a6d2e832b6"}","org_name":"二年级5","province_code":"","status":1,"certification":true},{"org_parent_id":null,"org_id":"002563b8bef311ec9e3ea2aa5f9415ff","org_short_name":"","area_code":"","org_type":4,"city_code":"","attribute":"{"org_coding": "dho6b94r", "auto_create_group": "0", "auto_create_wps_group": "0"}","org_name":"总务处","province_code":"","status":1,"certification":false}]},"status":"OK"}

返回说明

序号

字段

说明

1

org_id

组织id

 

org_parent_id

直属上级机构id,是机构、学校类型认证的组织才能有(比如A学校的上级是AA机构,AA机构的上级是AAA机构)

2

org_name

组织名称

3

org_short_name

组织简称

4

org_type

组织类型组织类型 “1”: “机构” “2”: “学校” “3”: “校区” “4”: “部门” “5”: “学段” “6”: “年级” “7”: “班级” “8”: “企业机构” “9”: “教学工作室” “10”: “平台”

5

province_code

地理省份

6

city_code

地理城市

7

area_code

地理区域

8

status

状态,0:组织未激活,1:正常,2:解散,3:锁定

9

attribute

机构属性

10

certification

认证(0:未认证,1:已认证)

11

org_level

行政等级,是机构、学校类型时返回 “1”: “国家” “2”: “省级” “3”: “地级” “4”: “县级” “5”: “乡级”

12

org_level_code

行政区划,是机构、学校类型时返回

13

org_parent_id

直属上级机构id,是机构、学校类型认证的组织才能有(比如A学校的上级是AA机构,AA机构的上级是AAA机构)

14

org_address

组织的联系地址

15

org_category

组织的类别(详细见文档十三.4),未设置时为空字符串

16

avatar

头像地址

17

org_has_child

机构属性 - 机构是否存在下级组织(1是,0否)








 

3.3机构管理员

接口访问地址

http://open-api.longyanedu.net/platform/getManagerList

接口方式

HTTP

提交方式

Post

入参

名称

必填

数据类型

说明

orgId

String

机构id

pageNum

Int

页码

pageSize

int

每页大小

出参

名称

数据类型

说明

errCode

String

结果编码,000000:成功

message

String

结果描述

result

String

返回内容

请求示例

{"pageNum":1,"pageSize":5}

返回示例

{"code":"000000","message":"success","result":{"page":{"startIndex":0,"totalPage":381,"currentPage":1,"totalSize":1903,"pageSize":5},"list":[{"user_type":1,"user_id":"ffee2b607fea11ec94a50236fa39e89f","org_id":"00014a927feb11ec94a50236fa39e89f","area_code":"350823","name":"上杭县通贤东里幼儿园","org_name":"上杭县通贤镇东里幼儿园","account":"17999999950,shxtxdlyey"},{"user_type":3,"user_id":"2234a1bcc7094c6dbac4c86ed2508da6","org_id":"002bf178fd81496fbf593ff7f6b8b42d","area_code":"350881","name":"ly2135005650","org_name":"漳平市永福中心学校","account":"zpsyfzxxx,13599607939"},{"user_type":1,"user_id":"003757227feb11ec94a50236fa39e89f","org_id":"004ac3d47feb11ec94a50236fa39e89f","area_code":"350823","name":"org_20220128","org_name":"上杭县通贤镇蓝天幼儿园","account":"17999999804,shxtxltyey"},{"user_type":4,"user_id":"6e50e20ea8c811ecbbbb0223164b2164","org_id":"00566cf0a41e11ecb636baee4ff06c9c","area_code":"350802","name":"lysjyjbgs","org_name":"龙岩市教育局办公室","account":"pu441279,420115199007170201"},{"user_type":3,"user_id":"a1d68be875ee4eac8a8a0a19a1dbd867","org_id":"006a235c8c1e42f2a8e10d807ca5e14a","area_code":"350823","name":"ly2135010182","org_name":"上杭县稔田镇化厚教学点","account":"17999999882,shxrtzhhjxd"}]},"status":"OK"}

返回说明

序号

字段

说明

1

org_id

机构Id

2

org_name

机构名称

4

user_id

主管理员用户Id

5

name

主管理员用户姓名

6

user_type

主管理员用户类型.

教育局机构:4机构人员;

学校:1老师、3工作人员








 

3.4是否是平台管理员

接口访问地址

http://open-api.longyanedu.net/user/checkIsAdmin

接口方式

HTTP

提交方式

get

入参

名称

必填

数据类型

说明

user_id

String

用户id

出参

名称

数据类型

说明

code

String

结果编码,000000:成功

message

String

结果描述

result

String

1:是管理员 0:不是管理员

请求示例

user_id=xx

返回示例

{

"result": 1,

"code": "000000",

"_runtime": "0.0053",

"message": "获取成功",

"_timestamp": "1656560038.6578"

}






 

3.5根据管理员用户编号获取管理角色

接口访问地址

http://open-api.longyanedu.net/user/getGroups

接口方式

HTTP

提交方式

get

入参

名称

必填

数据类型

说明

user_id

String

用户id

出参

名称

数据类型

说明

code

String

结果编码,000000:成功

message

String

结果描述

result

json

结果数组

请求示例

user_id=xx

返回示例

{

"code": "000000",

"message": "获取成功!",

"result": [{

"id": "1",

"name": "系统管理员",

"status": "1",

"source": "1",

"platform_code": "888880"

}],

"_timestamp": "1623079448.6684",

"_runtime": "0.0138"

}

返回说明

序号

字段

说明

1

id

角色编号

2

name

角色名称

4

status

状态 (1:开启,0:关闭)

5

source

系统别名

6

platform_code

虚拟平台编码








 


评论

还能输入140

用户评论

龙岩市教育局主办     技术运营支持:福建智慧海西信息技术有限公司   
Copyright©2022 www.longyanedu.net All rights reserved      ICP备案号: 闽ICP备09006768号

经过核实,本空间由于存在敏感词或非法违规信息或不安全代码或被其他用户举报,
已被管理员(或客服)锁定。
本空间现无法正常访问,也无法进行任何操作。
如需解锁请联系当地教育技术部门,由当地教育技术部门联系锁定人处理。

当前机构空间已被管理员(或客服)封锁。
目前机构空间无法正常访问,也无法进行任何操作。
如需重新开放,请联系当地教育技术部门,由当地教育技术部门联系管理员(或客服)处理。