龙岩市教育公共服务平台

服务中心

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

龙岩市教育数据共享服务平台-证书查询接口

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

 

 

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

证书查询接口

(版本号 V1.1

 

 

文档修订记录

版本号

状态

简要说明

日期

变更人

V1.1

新增

证书查询接口用户查询接口

2022.7.18

童倩

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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://open-api.longyanedu.net/certificate/search

接口方式

HTTP

提交方式

Get

入参

名称

必填

数据类型

说明

certificate_name

String

证书名称

 

certificate_card

String

证书编号

 

name

String

姓名

 

type

String

证书类型。1:荣誉证书,2:等级证书,3:职业证书,7:研训结业,8:继续教育,9:培训教育

出参

名称

数据类型

说明

code

String

结果编码,000000:成功

message

String

结果描述

data

String

返回结果

请求示例

certificate_name=xx

返回示例

{"errCode":"000000","msg":"Successed","data":{"totalNum":4,"currentPage":1,"records":[{"data":"{"获奖人身份证":"440825201301293980","组别":"一组","所在单位":"龙岩实验中学","证书编号":"20220118","作品":"5","获奖人姓名":"李永永"}","level":"州级","organization":"龙岩实验中学","certificate_name":"高级教师","name":"李永永","certificate_card":"20220118","content":"恭喜老师业务能力突出,获得荣誉证书!"},{"data":"{"获奖人胡姓名":"1","测试新增":"1","作品123":"1","获奖人身份证":"422201198807210011","所在单位":"1","证书编号":"1","证书1编号":"1","获奖人姓名":"aaaa"}","level":"校级","organization":"1","certificate_name":"-测试证书","name":"aaaa","certificate_card":"1","content":"11"},{"data":"{"获奖人身份证":"110101200203074637","组别":"小学组","奖项":"一等奖","所在单位":"龙岩测试学校","证书编号":"LY-LB-202207011001","作品":"优秀课例","获奖人姓名":"张明"}","level":"州级","organization":"龙岩测试学校","certificate_name":"演示证书0711","name":"张明","certificate_card":"LY-LB-202207011001","content":"恭喜老师业务能力突出,获得荣誉证书!"},{"data":"{"颁发日期":"20181126","指导老师":"黄龙琴","姓名":"新罗区代表队涂智玲、李晶、章皇","等级":"团体二等奖","获奖人身份证":"35080219000101273X","活动名称":"2018年龙岩市综合学科教师专项培训暨学科素养团体赛证书","组别":"小学音乐组","所在单位":"涂智玲(曹溪石粉小学)李晶(西安小学)章皇(实验小学)","证书编号":"YJY20182141360101","获奖人姓名":"新罗区代表队涂智玲、李晶、章皇"}","level":"校级","organization":"涂智玲(曹溪石粉小学)李晶(西安小学)章皇(实验小学)","certificate_name":"2018年龙岩市综合学科教师专项培训暨学科素养团体赛证书","name":"新罗区代表队涂智玲、李晶、章皇","certificate_card":"YJY20182141360101","content":"2018年龙岩市综合学科教师专项培训暨学科素养团体赛"}]}}

 

字段说明

字段

字段中文名

Id

id

data

数据

certificate_name

证书名称

certificate_card

证书编号

name

姓名

content

内容

备注

Pdf下载地址:http://zs.longyanedu.net/pdfDown/id







 

3.2用户查询

接口访问地址

http://open-api.longyanedu.net/auth/authByCard

接口方式

HTTP

提交方式

Get

入参

名称

必填

数据类型

说明

card_code

String

身份证号

出参

名称

数据类型

说明

code

String

结果编码,000000:成功

message

String

结果描述

data

String

返回结果

请求示例

certificate_name=xx

返回示例

{"errCode":"000000","msg":"Successed","data":{"totalNum":1,"currentPage":1,"records":[{"card_code":"352623197211051635","user_type":1,"gender":true,"phone":"13860213870","name":"刘文胜","org_name":"龙岩市永定区龙凤小学","account":"352623197211051635,13860213870,3574962615"}]}}

返回说明

字段

字段中文名

phone

手机号

org_name

机构名称

name

姓名

user_type

用户类型

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

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

企业机构:5企业人员;

隐性用户身份:2家长,注册时选择了身份类型的

gender

性别

account

账号

 

card_code

身份证







 


评论

还能输入140

用户评论

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

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

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