DB4401-T 223-2023 教育电子学习资源数据接口规范

35.240.01

DB4401 DB4401/T

223—2023教育电子学习资源数据接口规范Specification

of

data

interface

for

educational

e-learning

resources2023-

-

发布 2023

-

-

实施广州市市场监督管理局 发

布

4.1

4.2

5.1

5.2

5.3

5.4

5.5

5.6

API

sha1

加密代码实现(Java)

本文件按照

1.12020《标准化工作导则 第1部分：标准化文件的结构和起草规则》的规定

4880.1—2005

7408—2005

28825—2012

3.1

educational

resources3.2

interface

4.1

0607—2017

该资源的描述的名字20该资源知识内容所使用的人类语言主要种类，语种分类代码从《中国图书馆图书分

4880.1—2005“fr-CA”

正式标题之外的其他以文本方式对资源内用以描述资源主要内该资源所属学科课文mode该资源所适用的学习行为，体现学生在自主性、探究性和合作该资源的主要使用者，最重要的优先列curricularstandard描述该资源与国家课程标准内容框架的对code在实施教育教学的过程中，专门研究或讨

表1

source1000该资源引用的访问互“http://www.mauthor发布该资源的作者姓instructor该资源中的主讲人的authorc该资源创建者的所在authorc_code该资源创建者的所在广州市中小学的学校代码（广州市中小学学籍数据库中各个单author_Area_code该资源作者所在区域authorp_code该资源作者所在省份该资源作者所在城市该资源所属知识点标

JY/T0607—2017

vediopointvoicepointgrade_level_code

表1

该资源所属学科课文该资源所属学科课文该资源所属学科课文该资源所属学科课文该资源所属学科课章

2005

clicksumce_type_code该资源所属资源的类

该资源在技术上的数据类型，用于确定资格式分类代码引用

30资源所需计算机存储容量，该数据表明资该资源对应课程的出abstract该资源所在访问链接

表1

H1zhmnbougzakokkenfrdeesrujaarH9qt42的计43Resource

的分44与关45relationship_description

表1

4.2

4880.1—2005选取，如表2所示。

A01

表3

表4

4.2.4专题教育资源分类代码按照《中国图书馆图书分类法（第五版）》类目简表和

表5

ON01ON0101000～2

ON0102003～6

ON02ON020100ON020200ON020300ON020400ON020500ON020600ON03ON030100ON030200ON030300ON04ON040100ON040200ON040300ON05100ON05200ON05300SS11SS12SS13SS14SS15SS99

表5

表6

表7

RT01RT02RT03RT04RT05RT06RT07RT08SB0601SB0602SB0603SB0701SB0702SB0801SB0802SB0803

表7

表8

F001TXT(Text

F002RTF(Rich

Text

F003F004ODF(Open

Document

F005

Office

Document

F006PDF(Portable

Document

F007

Mobile

F008

Text

Markup

F009XML(Extensible

Markup

F010

(XML

Specification)F011

F012F013F015F016PostscriptF017F099F101

表8

表9

3)MIDI(Musical

Instrument

Audio)

AIFF(Audio

File

FLAC

Lossless

VOC(

Voice)S3M(Scream

Modules)

Music)CD(Compact

weighted

Interleave

Vector

ASF(Advanced

RM(Real

MP4(MPEG-4

F2

Pictures

Group)

Interleaved)RV(Real

RM(Real

Variable

Bitrate)

Video)ASF(Advanced

DIVX

Video）

表9

F214F215F216

Audio)F217RAM(Random

Access

F299图形/图像F301

Photographic

F302

F303F304

File

F305

F306F307F308F309F310EPS(Encapsulated

Post

F311

Graphics

F312

F313TGA(Tagged

F314F315SVG(Scalable

Vector

F316F317

Exchange

F318EPG(Electronic

Guide)F399其他图形/图像格式F401

Wave

Flash)F402

F403F499

表9

关联类型分类代码如表10所示。RS01Is

Part

Of

Part

RS02Is

Version

RS03Is

Format

Of

Format

RS04Is

Referenced

By

References

RS05Is

Replaced

By

Replaces

RS06Is

Required

Requires

String

StringString

5.1

所有接口统一按照HTTP

5.2

REST

HTTP

GET

POST

GET

URL

POST

URL

JSON

5.3

SUCCESS：成功FAILURE：失败errorsList500500500timestampDate100100

request_id

100Date应用程序发出请求的客户端时间，大平台在接收到请求后，与当前服务端时间比较，如果在误差范围大于

10

min，将请String应用程序发出请求的唯一标识号，大平台如果在误差时间内

message4000

5.3.3

5.3.4

access_token

检查程序是否正确提供了access_token

access_token

app_key

检查程序是否正确提供了

sign

sign_method

sign

sign_method

sign

sign_method

建议去掉

sign

参数采用不签名方式，或者

timestamp

request_id

timestamp

request_id

11100～

产生此错误的原因是会话尚未得到授权或者已经超时或

表示当前程序不是合法的应

试在发送请求前自行进行签a)

运行应用程序的客户端时间与接口服务端

b)

运行应用程序的客户端与接口服务端之间a)

因为程序错误导致在多次调用中产生了相

b)

由于网络原因请求被偶然重发，建议排查c)

请求被记录并重放，建议排查网络安全问12100～

码,

第三方应用程序未获得

13002会话未获得授权调用指当前会话上下文无权限执行所操作的对象超出当前

getXXX

可能用来判断是否存在此对象，建议调用getXXX

14110～

getXXX

14210～创建对象时主键或具有创建对象时不允许空属创建对象时部分属性不14310～创建对象时遇到的其它更新对象时主键或具有更新对象时不允许空属更新对象时部分属性不14410～更新对象时遇到的其它14510～在删除对象时遇到的其

19000～示接口服务端或客户端程序出现不可预测的内程序appSecretstring

Sign

按照一定顺序规则拼接

ppKey、timestamp、randomNum、appSecre

后，再使用

sha1

加密算法，生

字符串顺序规则：appSecret

randomNum

appKey

timestamp

sha1

5.4

access_token调用安全会话接口的login方法，以部门管理员账户创建会话获取访问令牌access_token，请求示

access_token

API

5.5

title

2000200special_subjectauthorcauthorc_codeauthor_area_codeauthorp_codeaccountnameidentity_numdivisiondivision_codeservice_orgextend_props4000creatorcreation_timeDatelast_modificatorlast_modification_timeDate

5.5.1

5.5.2

300grade_level_codeunit300300partclicksumsize30300abstract2000300

5.6

API

security/login.do URL

String500

String500

String500passwordString500org_codeString500access_tokenString500500

String500String500

500

5.6.2

security/logout.do

URL

5.6.3

security/get_current_user.do

String1000String100String200attributesTSUser500String500String500100List<DataSubjectInfo>50

data_subject/list.do URL

sha1

import

java.nio.charset.StandardCharsets;import

public

class

public

static

main(String[]

String

appSecret

String

randomNum

String

String

DigestSha

new

DigestSha();String

a.sha1(appSecret

randomNum

appSecret);System.out.println(sign);public

String

data)

MessageDigest

byte[]

dataByte

data.getBytes(StandardCharsets.UTF_8);messageDigest

MessageDigest.getInstance("SHA-1");messageDigest.update(dataByte);byte[]

messageDigest.digest();char

final

finalDataByte.length;final

char[]

out

new

char[len

len;

out[j++]

finalDataByte[i])

out[j++]

finalDataByte[i]];return

new

String(out);

catch

(Exception

throw

new

RuntimeException(e);

B.1

POST

application/json{"app_key":"APP_KEY","app_secret":"APP_SECRET","account":"ACCOUNT","password":"

{"success":true,"msg":"登陆成功！","obj":null,"attributes":{"access_token":"4028098184325ff2018432a1f22c0002","expires_in":86400}}

"ack_code":"SUCCESS","errors":[],"data":"account":"gz_byq","name":"白云区用户","identity_num":"440111************","service_org":"123456789","creator":"admin","creation_time":"2012-5-22","last_modification_time":"2012-5-22"

B.1.3 POST

http://{API_ROOT}/security/logout.do?access_token=ACCESS_TOKEN

application/json{"success":true,"msg":"退出成功","obj":null,"attributes":{"ack_code":"SUCCESS"}}B.2

B.2.1 POST

applicat