第三方调用开放平台服务用户指南

最新推荐文章于 2023-06-21 11:17:28 发布
最新推荐文章于 2023-06-21 11:17:28 发布
阅读量1k 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42451000/article/details/108489363
版权

第三方调用开放平台服务用户指南

作者：王张章 ; 邮箱：zzwang@iflytek.com

第三方请求接口服务说明

  1. 请求平台URL说明

    • 测试环境：http://test.zhixue.com/openapi/service/${serviceName}
    • 现网环境：http://www.zhixue.com/openapi/service/${serviceName}

      其中serviceName为配置在平台上的可用服务，具体可用服务见服务列表。如有可用服务为：getSchoolByClassId，则请求平台的url为：http://test.zhixue.com/openapi/service/getSchoolByClassId

  2. 请求平台方式和Content-Type类型说明

    • 平台支持HTTP POST和GET方式
    • 平台支持Content-Type类型包括application/x-www-form-urlencoded和application/json

      对于application/x-www-form-urlencoded类型GET和POST方式都可以请求平台
      对于application/json类型，只接收POST请求，请求的内容要在HTTP BODY中，平台只会解析body体中的数据

  3. 请求参数说明

    • 平台所需通用参数放在HTTP HEAD中,必传参数说明如下：
      1. appKey：向开放平台申请的唯一标识
      2. secrete：请求密钥(MD5加密)，为appCode+appKey+发起请求时的时间戳（毫秒）

        每次生成的密钥只被允许访问一次（测试环境为方便测试可能关闭）
        每次生成的密钥在半小时以内有效

      3. timeStamp：请求时的时间戳，和secrete中加密的时间戳保持一致
    • 接口业务参数根据HTTP请求方式和Content-Type放入queryString或者HTTP BODY中
      加密方式示例：
      StringBuffer sb = new StringBuffer();
      Long timeStamp=System.currentTimeMillis();
      sb.append(appCode).append(appKey).append(timeStamp);
      String secrete=ToolsUtil.getMD5(sb.toString(), “utf-8”);

消息格式和消息码定义

  • 开放平台提供统一的数据返回格式，通信格式为JSON，接口服务（见服务列表）返回的数据会放在data字段中，具体data数据体格式见服务列表中服务详细描述。定义如下：
    public class OpenResp { 

      /**
   * 响应消息码
   */
  private String code;

  /**
   * 响应消息描述
   */
  private String message;

  /**
   * 响应数据,主要为业务服务接口返回的json字符串类型的数据
   */
  private String data;

    }

消息码和消息描述定义：
SUCCESS(“0”,“成功”),
UNKNOWN_ERROR("-1",“系统错误”),
LACK_PLATFORM_PARAM(“10001”,“缺少平台必须参数或参数值为空”),
INVALID_PARAM(“10002”,“非法参数”),
URL_EXPIRED(“10003”,“链接超过半小时,请求失效”),
INVALID_APPKEY(“10004”,“无效的APPKEY”),
INVALID_SIGNATURE(“10005”,“无效的签名”),
URL_REUSED(“10006”,“同一url不能被重复使用,每次调用需要更新签名”),
PARSE_PARAM_ERROR(“10007”,“解析请求参数错误”),
SERVICE_NOT_EXISTS(“20001”,“请求服务不存在”),
SERVICE_CLOSED(“20002”,“请求服务不可用”),
NOT_ACCESS_SERVICE_AUTH(“20003”,“没有服务访问权限”),
NOT_AREA_ACCESS_AUTH(“20004”,“没有区域访问权限”),
CALLED_THIRD_URL_ERROR(“30001”,“调用业务接口出错”),
CALLED_THIRD_URL_NOT_FIND(“30002”,“业务接口地址不存在或错误”),
CALLED_THIRD_URL_TIMEOUT(“30003”,“业务接口调用超时”),
LACK_THIRD_URL_PARAM(“30004”,“缺少第三方业务接口必要参数”);

开放平台可用服务列表和详细描述

如无特殊说明，请求的Content-Type默认为application/x-www-form-urlencoded；返回的数据格式为JSON字符串

用户中心服务

  • userService-getStudent

  • userService-getUserByUserId

  • userService-getTeachersInClazz

  • userService-getStudents

  • userService-getUserByLoginName

  • userService-getTeachings

  • schoolService-getSchool

  • schoolService-getSchoolByUserId

  • clazzService-getClazzsByRole

  • clazzService-getBindClasses

  • subjectBaseService-getTeachSubjectsByExam

    • 服务详细描述：通过考试科目获取教学科目
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • code：考试科目
      • phase：学段

      可选参数说明：

    • 返回结果格式和字段说明

    {
    “code”: “0”,
    “message”: “成功”,
    “data”: “[
    {
    “code”: “05”,
    “name”: “物理”,
    “sort”: 140,
    “isMultiSubject”: false,
    “parentCode”: null,
    “isAddOrRemove”: true,
    “type”: null,
    “hasPrimary”: false,
    “hasJuniorMiddle”: true,
    “hasSeniorHigh”: true,
    “hasBasic”: true,
    “hasTeach”: true,
    “hasExam”: true,
    “hasCustom”: false,
    “customType”: null,
    “orgId”: “1”,
    “orgType”: “country”,
    “hasNewGaoKao”: true,
    “ident”: “required”
    }
    ]”
    }

  • userService-getStudent

    • 服务详细描述：根据学生id获取学生详细信息,不包含学生选课信息
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • studentId:学生ID

      可选参数说明：

    • 返回结果格式和字段说明

    胡神主未提供

  • userService-getUsersByUserCodes

    • 服务详细描述：批量根据学生学号获取学生的基本信息
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • userCodes:学号

      可选参数说明：

    • 返回结果格式和字段说明

    胡神主未提供

  • userService-getHeadTeacher

    • 服务详细描述：获取某个班级的班主任
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • clazzId:班级ID

      可选参数说明：

    • 返回结果格式和字段说明

    胡神主未提供

  • userService-getTeachersInClazz

    • 服务详细描述：获取某个班级教授某门学科的老师
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • classId:班级ID
      • subjectCode:学科code

      可选参数说明：

    • 返回结果格式和字段说明

    胡神主未提供

评价档案阅卷服务

  • getClassExamArchiveByExam

    • 服务详细描述：获取该学校某考试全部班级全学科统计数据
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • examId：考试ID(消息推送含此参数，以下相同)
      • schoolId：学校ID(消息推送含此参数，以下相同)

      可选参数说明：

    • 返回结果格式和字段说明

    [
    {
    “id”: “c0cf9499-5df4-4250-ae48-ab1105bb2d28”,
    “examId”: “b11fc8e5-2fc0-457f-b5b9-987d14f90e0f”,
    “examName”: “单人第一次月考数据”,
    “examCreateDateTime”: 1414053025000,//考试创建时间
    “createDateTime”: 1414054834350,//记录创建时间
    “gradeCode”: “09”, //年级ID
    “schoolId”: “2244000001000002392”,
    “subjectCode”: “03”,//学科ID
    “subjectCodes”: [ //学科ID列表
    “03”
    ],
    “version”: 1001,//版本号
    “isFinal”: null,//是否全科结束
    “markingExamTypeName”: null,//考试类型
    “markingExamTypeCode”: null, //考试类型编码
    “examDateTime”: null,//考试时间
    “reportVersion”: “1001”,//版本号
    “className”: “九年级45班”,
    “classId”: “2034000020000000727”,
    “classOrder”: null, //班级排序
    “studentCount”: null,//学生数目
    “submitStudentCount”: 1, //提交人数
    “unSubmitStudentCount”: 6, //未提交人数
    “tiStudentCount”: 0, //剔除学生数目
    “avgScore”: 116.0,//平均分
    “maxScore”: 116.0,//最高分
    “minScore”: 116.0,//最低分
    “scoreSections”: [
    {
    “minScore”: 0.0, //分段起始分数
    “maxScore”: 15.0, //分段结束分数
    “count”: 0, //分段人数
    “rate”: 0.0 //分段人数赞比
    }
    ],
    “standardDeviation”: 0.0,//标准差
    “tiArchive”: { //剔除学生之前班级统计信息
    tiScore:null 总分
    tiClassRank:null 班级排名;
    tiSchoolRank:null 校级排名
    tiGradeRank:null 年级排名
    tiAvgScore:null 平均分
    tiMaxScore:null 最高分
    tiMinScore:null 最高分
    tiExcellentRate:null 优秀率
    tiExcellentCount:null 优秀人数
    tiGreatRate:null 良好率
    tiGreatCount:null 良好人数
    tiQualifiedRate:null 合格率
    tiQualifiedCount:null 合格人数
    tiDisQualifiedRate:null 不合格率
    tiDisQualifiedCount:null 不合格人数
    tiPassCount:null 及格人数
    tiPassRate:null 及格率
    tiStudentCount:null 被剔除的学生数
    tiScoreSections:null 被剔除的学生数
    tiUserSubjectScores:null 学生单学科分数、
    schoolDeptRan:null 文理考生排名
    schoolElectiveRank:null 选考组合排名
    tiCustomClassRank:null 自定义班级排名
    tiCustomSchoolRank:null 定义校级排名

    }
    “statStudentCount”: null //统计学生数

  • getSchoolClassArchiveMonList

    • 服务详细描述：获取该学校某考试全部班级单科统计数据
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • examId：考试ID
      • schoolId：学校ID

      可选参数说明：

    • 返回结果格式和字段说明

    [
    {
    “id”: “412a7846-0689-493b-bbf5-8000ade6b382”,
    “subjectCode”: “03”, //学科ID
    “subSubjectCodes”: null, //子学科
    “gradeCode”: “09”,年级ID
    “schoolId”: “2244000001000002392”, 学校ID
    “topicSetId”: “4782b05c-4a56-4c07-828e-683b3e09de4c”, 试卷ID
    “topicSetName”: “单人第一次月考数据(英语)”, 试卷名称
    “standardScore”: 150.0, //试卷满分
    “createPaperTime”: 1414053026000, //试卷创建时间
    “createTime”: 1414054833905, //记录创建时间
    “updateTime”: 1414054833905, //更新时间
    “examId”: “b11fc8e5-2fc0-457f-b5b9-987d14f90e0f”, //
    “examName”: “单人第一次月考数据”,
    “markingExamTypeName”: null,//考试类型
    “markingExamTypeCode”: null, //考试类型编码
    “examCreateDateTime”: null, //考试创建时间
    “examDateTime”: null, //考试时间
    “classId”: “2034000020000000727”,
    “className”: “九年级45班”,
    “classOrder”: 209045,
    “classTeacherName”: “方新宇”,
    “avgScore”: 116.0, //平均分
    “maxScore”: 116.0, //最高分
    “minScore”: 116.0, //最低分
    “excellentCount”: 0, //优秀学生数目
    “wellCount”: 1,//良好学生数目
    “qualifiedCount”: 0, //合格学生数目
    “disQualifiedCount”: 0,//不合格学生数目
    “passCount”: 1,//及格人数
    “excellentRate”: 0.0,//优秀学生占比
    “passRate”: 1.0, //及格人数
    “qualifiedRate”: 0.0,//合格学生占比
    “wellRate”: 1.0,//良好学生占比
    “disQualifiedRate”: 0.0,//不合格学生占比
    “scoreSections”: [ //班级分段统计
    {
    “minScore”: 0.0, //分段起始分数
    “maxScore”: 15.0, //分段结束分数
    “count”: 0, //分段人数
    “rate”: 0.0 //分段人数赞比
    }
    ],
    “standardDeviation”: 0.0, 班级学生标准差
    “studentCount”: 7, //班级学生数
    “submitStudentCount”: 1, //提交人数
    “unSubmitStudentCount”: 6, //未提交人数
    “tiStudentCount”: 0, //剔除学生数目
    “archiveStepScore”: null, //档案分步分数
    “tiArchive”: {
    tiScore:null 总分
    tiClassRank:null 班级排名;
    tiSchoolRank:null 校级排名
    tiGradeRank:null 年级排名
    tiAvgScore:null 平均分
    tiMaxScore:null 最高分
    tiMinScore:null 最高分
    tiExcellentRate:null 优秀率
    tiExcellentCount:null 优秀人数
    tiGreatRate:null 良好率
    tiGreatCount:null 良好人数
    tiQualifiedRate:null 合格率
    tiQualifiedCount:null 合格人数
    tiDisQualifiedRate:null 不合格率
    tiDisQualifiedCount:null 不合格人数
    tiPassCount:null 及格人数
    tiPassRate:null 及格率
    tiStudentCount:null 被剔除的学生数
    tiScoreSections:null 被剔除的学生数
    tiUserSubjectScores:null 学生单学科分数、
    schoolDeptRan:null 文理考生排名
    schoolElectiveRank:null 选考组合排名
    tiCustomClassRank:null 自定义班级排名
    tiCustomSchoolRank:null 定义校级排名

    }

      "isAdmin": true, //是否行政班
  "isTeach": false, //是否教学班
  "levelDistributions": null, 等级分布占比情况
  "statStudentCount": 1, //统计学生数目
  "zscore": 3.0 //z分数
}

    ]

  • getAllUserExamArchiveByExamClass

    • 服务详细描述：获取该学校某考试全部学生全科统计数据
    • HTTP请求方式：GET
    • 请求参数说明：

      必传参数说明：

      • examId：考试ID
      • schoolId：学校ID
      • classId：班级ID（通过接口getSchoolClassArchiveMonList获取）

      可选参数说明：

最低0.47元/天 解锁文章
AAA ✨ qy
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
阿里开放平台接入——开放平台注册与API调用
kongpingyuansu的博客
06-09 5241
文章目录1.背景2.注册账户3.获取key4.能力列表5.开发文档6.获取SDK7.注意事项8.实在搞不定了点我 1.背景 目前对于大部分使用开放平台提供的技术开发应用的开发者而言，开始研发之前的注册，资质认证，应用创建，审核，环境测试等步骤说长不长，说短也不短，但繁琐的步骤无遗会消耗大量的精力，劳心劳力。 阿里云视觉智能开放平台开放了阿里内部应用使用的200+视觉AI能力，包括人脸识别，图像识别，文字识别OCR，分割抠图，目标检测，3D视觉，内容审核，视频处理，医疗辅助等领域等。用于开发人脸闸机，商品识别
Springboot网站第三方登录 微信登录
08-28
在本文中，我们将深入探讨如何在Springboot项目中实现第三方登录功能，特别是微信登录。Springboot框架因其便捷性与灵活性，被广泛应用于构建Web应用程序。而整合第三方登录服务，如微信登录，能为用户提供更加方便...
WebService调用第三方服务的案例
10-15
WebService调用第三方服务的案例，中英文自动转换，服务是webxml提供的，有需要的伙伴们可以下载
【Java工具类】（24）—统一调用第三方服务地址
九离的博客
03-29 288
Java工具类（24）—统一调用第三方服务地址 package com.awifi.cloudnative.container.manage.provider.request; import com.alibaba.fastjson.JSON; import com.awifi.cloudnative.container.common.basic.ResponseJson; import com.google.gson.*; import com.netflix.hystrix.contrib.java
嵌套模板设计模式优雅解决通用调用第三方服务方案
carl.zhao的专栏
12-24 1073
最近公司正在服务化，因为公司是建筑行业的产业互联网。所以对于工人进出场考勤或者核心链路上都是需要用户进行证明“我是我”这个问题。那么就涉及到调用 ``实名认证``、``人脸比对``、``人脸质量``、``身份证OCR`` 等第三方服务。
服务的调用方式
zhangtie_y的博客
07-22 496
RPC和HTTP    无论是微服务还是SOA，都面临着服务间的远程调用。常见的远程调用方式有以下2种： 1.RPC：Remote Produce Call远程过程调用，类似的还有RMI（remote method invoke）。自定义数据格式，基于原生TCP通信，速度快，效率高。早期的webservice，现在热门的dubbo，都是RPC的典型代表。 2.Http：http其实是一种网络传输协...
iOS微信第三方登录实现
09-02
在iOS平台上实现微信第三方登录，主要是借助微信提供的OAuth2.0授权系统，允许用户通过自己的微信账号安全地登录你的应用程序。下面将详细讲解这个过程。 首先，你需要在微信开放平台注册一个开发者账户，并且创建...
使用Android开发接入第三方原生SDK实现微信登录
08-19
在Android开发中，接入第三方原生SDK，特别是像微信这样的社交平台，可以帮助你的应用程序实现更多的功能，例如微信登录。以下是一份详细的指南，涵盖了如何在Android应用中集成微信SDK实现微信登录。 首先，你需要...
Java实现QQ第三方登录源码.rar
10-25
Java实现QQ第三方登录涉及到的是社交网络开放平台的API接入，主要使用了QQ互联提供的服务。在本文中，我们将深入探讨如何使用Java进行QQ第三方登录的实现，以及涉及到的关键技术和步骤。 首先，QQ第三方登录的核心...
IOS第三方登录
09-12
在iOS应用开发中，集成第三方登录服务已经成为一种常见的实践，为用户提供更加便捷的登录体验。标题"iOS第三方登录"指的是在iOS应用中整合如微信、QQ、微博等社交平台的登录方式，允许用户通过自己的社交账号快速...
api数据接口调用服务平台
11-19
api数据接口调用服务平台，语言php， 包含二维码图片生成，网易云随机热评，随机风景图片，随机每日一言等api
构建第三方开放平台接口
Ghost_B2的博客
12-02 331
appid机制 只有appid和密钥验证通过了才能调用接口，并不是谁都能来调用我们的接口的，有点类似系统中的登录，需要使用的接口的用户需要在后台开通appid，提供给用户相关的密钥，在调用接口中需要提供appid和密钥，服务器端会进行相关的验证 签名机制 防止参数篡改 限流机制 防止流量攻击导致服务器或者数据库宕机 黑白名单机制 数据加密机制 使用https协议，在http和tcp之间添加一层...
理解paas平台，rpc调用，soa服务（架构，调用模式）
c1286912980的博客
09-21 1036
rpc和webservice通过xml或soap，wsdl协议调用 。现如今用的比较少，多是用http远程调接口。 随着网络基础设施的逐步成熟，从RPC进化到Web Service，并在业界开始普遍推行SOA，再到后来的RESTful平台以及云计算中的PaaS与SaaS概念的推广，分布式架构在企业应用中开始呈现出不同的风貌，然而殊途同归，这些分布式架构的目标仍然是希望回到建造巴别塔的时代，系统之...
服务的发现和调用
Stephen GS的博客
08-01 517
服务的发现和调用
三方开放接口，Springboot通过AOP实现API接口的签名验证
最新发布
qq_32430463的博客
06-21 2720
对外开放的接口，需要验证请求方发送过来的数据确实是由发送方发起的，并且中途不能被篡改和伪造，所以才会对接口的访问进行签名验证，以保证双方获取到的原来的信息是没有经过篡改的。@Aspect //定义一个切面@Slf4j//接口签名验证超时时间//接口签名唯一密钥// 定义切点Pointcutlog.info("开始验证签名");try {//获取timestamp参数//获取sign参数return RestResult.failed("timestamp和sign参数不能为空");
第三方平台接口接入详解
Gerry的专栏
11-18 5049
[平台] 请求传递参数(GET): 序号 参数名称 参数类型 备注 用户id qid int（13） 帐号是3－13位，纯数字，运营商用户唯一标识103023361 服务器ID sid varchar(6) 游戏各个分区的编号为 S1，S2，S3 时间 time timestamp 时间戳的格式1309587086 登录签名 sign varchar(32) 生成方法详看备注f1940c03ccd
微信服务号和第三方平台对接（前端）
热门推荐
梦想家小阿新的博客
05-25 1万+
微信公众号：1、服务号（每个月只能推送4篇文章，申请收费，更多高级功能：自定义菜单等，）2、订阅号（每天都可以推送文章，申请免费）消息出现的位置不同，订阅号统一在微信订阅号模块下管理。二者共用一种对接方式。了解详情一、引导用户打开授权页面window.location.href = 'https://open.weixin.qq.com/connect/oauth2/authorize?appid...
速卖通开放平台调用菜鸟组件实现云打印
chimian0298的博客
11-02 690
公司是跨境电商，使用速卖通平台卖玩具，我们自己研发的ERP是基于速卖通开放平台API，实现订单的发货提交，打印面单等功能 近期公司要求使用菜鸟组件云打印，去平台里看下，有这个API，如下图所示 clip_image002 实现也很容易，返回...
使用技巧-Z平台为第三方系统开放接口过程
★ 赵戬 ★ 一名JAVA程序员的博客
06-21 5333
大家好，实际工作中，经常会遇到为第三方系统开放访问接口的工作任务，那么，在Z平台中怎样为第三方快速开放接口的呢？下面，我为大家介绍一下操作流程。 示例说明： 在Z平台系统中，将产品信息表单的“查询接口”和“修改接口”开放给第三方系统，要求，第三方系统在访问接口时需时提交Z平台提供用户密钥进行接口访问。通过访问该接口，第三方系统可以快速的查询与修改Z平台产品信息表记录。 操作过程： 1.设置“产品信息”表单，开放“查询接口”与“修改接口”访问权限。 打开“表单管理”功能，找到“产品信息”表单。进入表
微信开放平台 第三方平台授权流程.pdf
11-13
。。。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值