龙岩市教育公共服务平台

服务中心

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

龙岩市教育数据共享服务平台-门户统一风格接口

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

 

 

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

门户统一风格接口

(版本号 V1.1

 

 

文档修订记录

版本号

状态

简要说明

日期

变更人

V1.1

新增

门户统一风格接口

2022.7.4

童倩

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

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/html/commonhtml

接口方式

HTTP

提交方式

Get

入参

名称

必填

数据类型

说明

type

String

header 获取头footer 获取尾

 

islogin

String

登录状态 默认 0 未登录,1登录

 

usessionid

String

用户中心会话(这个需要与用户中心对接登录信息)

出参

名称

数据类型

说明

code

String

结果编码,000000:成功

message

String

结果描述

result

String

头尾相关html内容

请求示例

type=xx&islogin=0

返回示例

{"result":{"sCommonURL":"http://www.longyanedu.net/index.php?r=api/commonhtml/header&portaltype=0&islogin=0&version=4.0&platformtype=&hidetopnewjs=0&usessionid=&areacode=350800&resourceid=&ticket=&from=other","base64":0,"sCommonContent":"<!-- 4.0 virtual platform header -->rn<!-- default -->rn<!-- from: other -->rn<link rel="shortcut icon" href="http://www.longyanedu.net/css/tianyu_edu/area/350800/images/logo/edu.ico?20201204" type="image/x-icon" />rnrn<link href="http://www.longyanedu.net/css/tianyu_edu/area/350800/css/w_public.css" rel="stylesheet" type="text/css" />rn    <link href="http://www.longyanedu.net/css/tianyu_edu/area/edu7.0/css/index.css" rel="stylesheet" type="text/css" />rn<!--<link href="http://www.longyanedu.net/css/tianyu_edu/area/350800/css/index5.css" rel="stylesheet" type="text/css" />-->rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/common/js/jquery.js"></script>rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/common/js/fun.js"></script>rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/common/js/ajaxForm.js"></script>rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/common/js/jquery.artDialog.js"></script>rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/common/js/jquery.artDialog.plugins.js"></script>rn<!--rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/area/350800/js/topnew.js"></script> rn-->rn<script type="text/javascript" src="http://www.longyanedu.net/css/tianyu_edu/common/js/jquery.mousewheel.min.js"></script>rn<input type="hidden" value="ccnamec" name="yasss" />  rn<div class="g_header">rn    <!-- 用过了啊 -->rn  <div class="m_wrap m_header clearfix">rn    <h1 class="logo fl" ><a  href="http://www.longyanedu.net"><em></em><img src="http://www.longyanedu.net/css/tianyu_edu/area/350800/images/logo/logo.png?v=2"   alt="" /></a>rn            </h1>rn            <div class="r_rect">rn        <ul class="menu fl" >rn                  <li><a  href="http://www.longyanedu.net" cha="sds22" class="menuA ">首页</a></li>rn            rn            rn                            tttt                                                                                                <li><a kk="1" target="_blank"  class="menuA " href="http://www.longyanedu.net/?r=portal/back/gzturls&url=http%3A%2F%2Fstu-resource.longyanedu.net%2F" >资源</a></li>rn                                       rn                                tttt                                                                                                <li><a kk="1"   class="menuA " href="http://www.longyanedu.net/space/index.php?r=space/index/spaceindex" >空间</a></li>rn                                       rn                                tttt                                                                                                <li><a kk="1" target="_blank"  class="menuA " href="http://www.longyanedu.net/?r=portal/back/gzturls&amp;url=http%3A%2F%2Fgateway.longyanedu.net%2Fmumu-edu%2Findex" >教师研训</a></li>rn                                       rn                                tttt                                                                                                <li><a kk="1"   class="menuA " href="http://www.longyanedu.net/apps/" >应用</a></li>rn                                       rn                                tttt                                                                                                <li><a kk="1"   class="menuA " href="http://inc.longyanedu.net/" >云网中心</a></li>rn                                       rn                                tttt                                                                                                <li><a kk="1" target="_blank"  class="menuA " href="http://www.longyanedu.net/open/" >开放平台</a></li>rn                                       rn                                                                                           rn                  tt                                                      tttrn                                                rn                             </ul>rn        <div class="head_nav">rn                <p class="navLoginRect fl">rn                                                                    <a href="http://www.longyanedu.net/index.php?r=portal/user/login" class="loginBtn" id="login_btn" >登录</a>rn                                            </p><p class="navLink fl">rn                        t                    </div> rn    </div>rn            <div class="r_rect head_nav dis_none">rn    <div class="search" id="top_search">rn      <dl class="clearfix" id="search_nav">rn          <dt>资源</dt>rn          <dd>rnttt<i></i>rnttt<a href="#" onclick="change_type(1)">资源</a> rnttt<a href="#" onclick="change_type(2)">应用</a>rnttt<a href="#" onclick="change_type(3)">找人</a>rnttttttttt<a href="#" onclick="change_type(6)">学校</a>rnttttt</dd>rn      </dl>rnttt<input type="text" class="inp_txt" id="search_content" placeholder="" />rnttt<input type="hidden" id="search_type" value="1" />rnttt<input type="button" class="inp_btn" onclick="search_jump()"/>rn    </div>rn  </div>rn  </div>rn</div>rn<!--跑马灯 begin-->rn<!--//跑马灯 end-->rn<script>rnfunction change_type(s_type){rn  $("#search_type").val(s_type);rn}rn$('#search_content').bind('keypress', function (event) {rn            if (event.keyCode == "13") {rn               search_jump();rn            }rn});rnfunction search_jump(){rn  var search_type = $("#search_type").val();rn  var search_content = $.trim($("#search_content").val());rnrn  tvar re_script=/<script.*>.*script>/;rntvar re_iframe=/<iframe.*>.*iframe>/;rntvar re_style=/<style.*>.*style>/;rntif(re_script.test(search_content) || re_iframe.test(search_content)||re_style.test(search_content)){rnttart.tips({content:'您当前输入的内容存在风险,请重新输入',type:'0'});rntt$("#search_content").val('')rnttreturn false;rnt}rn  var url = encodeURIComponent("http://www.longyanedu.net/index.php?r=center/person/address/friendship&keyword="+search_content);rn  var http = 'http';rn // if(search_content!=''){rn    if(search_type=='1'){rn      location.href = http+"://res.t.huijiaoyun.com/searchCont.html?title="+search_content;rn    }else if(search_type=='2'){rn      location.href = "http://www.longyanedu.net/apps/ac/list?name="+search_content;rn    }else if(search_type=='3'){rn                             location.href = "http://www.longyanedu.net/index.php?r=portal/user/login&service="+encodeURIComponent(window.location.href);rn                }else if(search_type=='4'){rntt  location.href ="http://www.longyanedu.net/index.php?r=course/searchcourse/course&search="+search_content;rntt  rnt  }else if(search_type=='5'){rnttt location.href ="http://www.longyanedu.net/index.php?r=studio/square/search&type=studio&key_words="+search_content; rnt  }else if(search_type=='6'){rntt  location.href ="http://www.longyanedu.net/index.php?r=space/index/Spaceindex/search&cls=org_space&type=school&keywords="+search_content;rnt  }rn      rn   // }rn  }rn  rn/* function login_tips(){rn  var search_type = $("#search_type").val();rn  var search_content = $.trim($("#search_content").val());rn  var url = encodeURIComponent("http://www.longyanedu.net/index.php?r=center/person/address/friendship&keyword="+search_content);rn  rn  if(search_type=='3'){rn      //  if(search_content==''){rn    location.href = "http://www.longyanedu.net/index.php?r=portal/user/login&service="+url;//}rn        rn    rn  }rn} */rnrnrn</script>rn<script>rnfunction strSimilarity2Percent(a,b){rnt//a为基准,a长度为百分比rnt//不匹配?防止首页这种无问号的类型,多匹配数据rnta=a .replace(/\/index\.php\?r=/g,"");rntb=b .replace(/\/index\.php\?r=/g,"");rnta=a .replace(/\?/g,"");rntb=b .replace(/\?/g,"");rnta=a .replace(/\http:\/\//g,"");rntb=b .replace(/\http:\/\//g,"");rnta=a .replace(/\https:\/\//g,"");rntb=b .replace(/\https:\/\//g,"");rntvar acount=a.length;rntvar bcount=b.length;rntvar zcount=acount>bcount?bcount:acount;rntvar lnum;rntfor (i = 0; i < zcount; i++) {rnttif(a[i]!=b[i]){rntttlnum=(i)/acount;rntttbreak;rntt}else if(i==(zcount-1)){ //尽量少匹配这里加一个极小值rntttlnum=(i+1)/acount;rntttif(bcount<=acount){//b长度刚好结束,a还有剩余rnttttlnum=lnum+0.00000001;rnttt}rntttbreak;rntt}rnt}rntreturn lnum;rn}rnfunction getQueryVariable(variable)rn{rn       var query = window.location.search.substring(1);rn       var vars = query.split("&");rn       for (var i=0;i<vars.length;i++) {rn               var pair = vars[i].split("=");rn               if(pair[0] == variable){return pair[1];}rn       }rn       return(false);rn}rn function getQueryUrl(curl,variable)rn{rn       var query = curl.split("?");rnt    if(query[1]){rntt   var vars = query[1].split("&");rntt   for (var i=0;i<vars.length;i++) {rntttt   var pair = vars[i].split("=");rntttt   if(pair[0] == variable){return pair[1];}rntt   }rnt   }rn       return(false);rn}rnvar cur_url=document.location.href?document.location.href:window.location.href;rnvar z_index='0';rnvar z_pre='0';rnvar z_flag=1;rn$('.menu li').each(function(){rn    var i=strSimilarity2Percent(cur_url,$(this).find('a').attr('href'));rn    if(i>z_pre){rn        z_index=$(this).index();rn        z_pre=i;rn    }rn}); rnif($('.pos_rel a').length>0){rn    $('.pos_rel a').each(function(){rn        var j=strSimilarity2Percent(cur_url,$(this).attr('href'));rn        if(j>z_pre){rn            z_index=$(this).index();rn            z_pre=j;rn            z_flag=0;rn        }rn    })rn}rnif(z_flag==1){rntif($('.menu li a.on').html()!='首页'){rnttif(!getQueryVariable('r')){rntt    //如果是门户空间的链接进行更为详尽的匹配rn            $('.menu li a.on').removeClass('on');rn            $('.menu li').eq(z_index).find('a').addClass('on');rntt}else{rntttif(getQueryUrl($('.menu li').eq(z_index).find('a').attr('href'),'r')==getQueryVariable('r')){rntttt$('.menu li a.on').removeClass('on');rntttt$('.menu li').eq(z_index).find('a').addClass('on');rnttt}rntt}rnt}rn}else{rn//$('.menu li a.on').removeClass('on');rn//$('.pos_rel a').eq(z_index).addClass('on');rn}rn</script>rn","platformCode":"350800"},"exectime":"0.009","retCode":"000000","message":"请求成功!"}






 

 


评论

还能输入140

用户评论

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

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

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