朗环档案管理软件V9.0
数据归档接口文档
南京朗环信息技术有限公司
2026年01月08日
目录
1 文档概述
1.1 引言
1.2 文档服务对象
2 接口使用
2.1 基础接口
2.1.1 RSA公钥获取
2.1.2 验证服务
2.2 数据归档
2.2.1 获取档号
2.2.2 批量获取档号
2.2.3 传输文件封包
2.2.4 常见错误代码
2.2.5 归档结果的异步通知接口
3 业务系统数据归档步骤简述(以OA为例)
3.1 档案系统提供接口参数
3.2 获取token
3.3 获取档号
3.4 传输文件封包
3.5 增加归档结果的异步通知接口接收归档情况
1 文档概述
1.1 引言
档案管理系统提供标准接口,方便二次开发。接口包括身份验证接口、数据对接接口等。此文档服务于二次开发人员以及客户IT管理人员。
1.2 文档服务对象
服务对象 |
服务内容 |
二次开发人员 |
开发文档、案例支持,需求问题反馈渠道。 |
客户IT管理人员 |
了解系统技术。 |
2 接口使用
2.1 基础接口
2.1.1 RSA公钥获取
为了防止验证服务调用过程中密钥的泄露,在传递用户名和密钥的时候需要采用RSA算法加密。
2.1.1.1 参数说明
方法名称:getPublicKey
2.1.1.1.1 提交参数
参数名称 |
参数描述 |
无 |
无 |
2.1.1.1.2 返回参数
返回参数名称 |
参数描述 |
code |
返回的代码,0表示成功,1表示失败 |
count |
返回的数据数量 |
data |
返回的数据,包括publicKey |
msg |
成功或失败的消息 |
2.1.1.2 调用示例
2.1.1.2.1 Java调用示例
OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .build(); Request request = new Request.Builder() .url("127.0.0.1:8080/open_api/getPublicKey") .method("POST", body) .build(); Response response = client.newCall(request).execute(); |
2.1.1.2.2 PHP调用示例
<?php require_once 'HTTP/Request2.php'; $request = new HTTP_Request2(); $request->setUrl(' 127.0.0.1:8080/open_api/getPublicKey'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } |
2.1.1.2.3 C#调用示例
var client = new RestClient("127.0.0.1:8080/open_api/getPublicKey"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AlwaysMultipartFormData = true; IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
2.1.1.2.4 Javascript-Jquery调用示例
var form = new FormData(); var settings = { "url": "127.0.0.1:8080/open_api/getPublicKey", "method": "POST", "timeout": 0, "processData": false, "mimeType": "multipart/form-data", "contentType": false, "data": form }; $.ajax(settings).done(function (response) { console.log(response); }); |
2.1.1.3 返回值示例
{ "code": 0, "count": 1, "data": { "PublicKey": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCoGY4IbZDpRHT4jibvYC91e1f63EcnNJzHscwtQpk03FaXwkEQ6gieZ0wTK1qRBwvP8XaTtM2O7np1WpzrhQgJRpG/pokt221A476mfW9FFFodhwJM4Ol7TdHi8AmC2EVqXhNGwkeB6ba9LgJHVRBnZgQj6FnxlDcPqjBNWwBB2QIDAQAB" }, "msg": "获取成功" } |
2.1.2 验证服务
访问RESTful风格的WebService时首先要进行身份验证获取token,所有服务都必须提供合法的令牌ID方可调用。
为保证安全,验证服务必须使用POST方式,用户名和密钥使用请求Body以JSON格式发送。
2.1.2.1 参数说明
方法名称gettoken
2.1.2.1.1 提交参数
参数名称 |
参数描述 |
appkey |
API接口验证序号,是用于验证API接入合法性的 |
appsecret |
接口的密钥,传递前需要使用RSA算法加密,公钥为RSA公钥获取接口获取的公钥 |
2.1.2.1.2 返回参数
返回参数名称 |
参数描述 |
code |
返回的代码,0表示成功,1表示失败 |
count |
返回的数据数量 |
data |
返回的数据,包括unitid、userid、token三个值 |
msg |
认证成功或失败的消息 |
2.1.2.2 调用示例
2.1.2.2.1 Java调用示例
OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .addFormDataPart("appkey","oatest") .addFormDataPart("appsecret","RVJa0BMH78E57aNtmU584A1wnypToqznNfKF6ruO57BOHOEC6+NV28M/sqiPx6mir/xOiyvOkkhv3cb1wGZNhqb5ltudlRQBpZAJgbsXKLBUqKbRwWp82JLZnkfDyudFLuPoyLF7LtKPOsL0K3KglD5OYFdigaPUf44v32DocTykQ6bJ6qW2ERBoIOnFpmLH7iSjiX9+NnVurQjCn1bKB7Jf6vj8DAnLPdG85yrsFDK1WlWPkVathhvymXcYzH162tBOwwE7a8UUmNsqw9hEGxoO2mEUxgvqPodtMwxwnad2MF30d6RZwQ4Lq4ZLCZew68xFDz5nsqAP1iaWQDcF7Q==") .build(); Request request = new Request.Builder() .url("127.0.0.1:8080/open_api/gettoken") .method("POST", body) .build(); Response response = client.newCall(request).execute(); |
2.1.2.2.2 PHP调用示例
<?php require_once 'HTTP/Request2.php'; $request = new HTTP_Request2(); $request->setUrl(' 127.0.0.1:8080/open_api/gettoken'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->addPostParameter(array( 'appsecret' => 'HJqnohUBet8Y8bSvN5o47WLqwft7lExBsWq7UrWYqSEt6o8e/dmV7j+Vjb96bukogpMzZx8aaf5iJEtmoES0S55EOEjQ5X/hpG7n6UAnzB0oywH4ZhfoIzTK7sOIngUIsvzJL/29aIY05MWdk3ZgzUM1N2wcSYjtdh8kHVfPXeZ9hhC6R2CW9i+ocSJdUPeWFgStJWgJ8OvmIyUvx2O6dDtxRztIJN3UI9aag4dyE6HtHuycjx89ykse8Ad9+CmAsTQ==', 'appkey' => 'oatest' )); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } |
2.1.2.2.3 C#调用示例
var client = new RestClient("127.0.0.1:8080/open_api/gettoken"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AlwaysMultipartFormData = true; request.AddParameter("appkey", "oatest"); request.AddParameter("appsecret", "RVJa0BMH78E57aNtmU584A1wnypToqznNfKF6ruO57BOHOEC6+NV28M/sqiPx6mir/xOiyvOkkhv3cb1wGZNhqb5ltudlRQBpZAJgbsXKLBUqKbRwWp82JLZnkfDyudFLuPoyLF7LtKPOsL0K3KglD5OYFdigaPUf44v32DocTykQ6bJ6qW2ERBoIOnFpmLH7iSjiX9+NnVurQjCn1bKB7Jf6vj8DAnLPdG85yrsFDK1WlWPkVathhvymXcYzH162tBOwwE7a8UUmNsqw9hEGxoO2mEUxgvqPodtMwxwnad2MF30d6RZwQ4Lq4ZLCZew68xFDz5nsqAP1iaWQDcF7Q=="); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
2.1.2.2.4 Javascript-Jquery调用示例
var form = new FormData(); form.append("appkey", "oatest"); form.append("appsecret", "RVJa0BMH78E57aNtmU584A1wnypToqznNfKF6ruO57BOHOEC6+NV28M/sqiPx6mir/xOiyvOkkhv3cb1wGZNhqb5ltudlRQBpZAJgbsXKLBUqKbRwWp82JLZnkfDyudFLuPoyLF7LtKPOsL0K3KglD5OYFdigaPUf44v32DocTykQ6bJ6qW2ERBoIOnFpmLH7iSjiX9+NnVurQjCn1bKB7Jf6vj8DAnLPdG85yrsFDK1WlWPkVathhvymXcYzH162tBOwwE7a8UUmNsqw9hEGxoO2mEUxgvqPodtMwxwnad2MF30d6RZwQ4Lq4ZLCZew68xFDz5nsqAP1iaWQDcF7Q=="); var settings = { "url": "127.0.0.1:8080/open_api/gettoken", "method": "POST", "timeout": 0, "processData": false, "mimeType": "multipart/form-data", "contentType": false, "data": form }; $.ajax(settings).done(function (response) { console.log(response); }); |
2.1.2.3 返回值示例
{ "code": 0, "count": 1, "data": { "unitid": "oa", "userid": "oatest", "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2NTA5OTE4MDAsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY1MDk2MzAwMCwianRpIjoiODhmZDI3NDQtMjZmNS00YTlmLTkyYmMtNzk5MDYwNzRlMGQ1In0.RlhUDkzd-ybzBWhj2qtIsp26rHxZz09PcvN6jJX1XGc" }, "msg": "认证成功" } |
2.2 数据归档
2.2.1 获取档号
2.2.1.1 参数说明
方法名称:getDh。
2.2.1.1.1 提交参数
此处参数示例是常见档案归档过程中使用的参数,必填项不可缺失,其它著录项目如果没有值则可以不传递,如果有额外的字段也可以灵活添加。参数名称支持与档案系统里面字段一致的中文名称。
序号 |
参数名称 |
参数描述 |
1 |
token |
认证成功后获取的密钥,附加到header中,必填 |
2 |
ccode |
管理员提供的档案类别代码,必填 |
3 |
c1 |
一级目录 |
4 |
c2 |
二级目录 |
5 |
c3 |
三级目录 |
6 |
qzh |
全宗号 |
7 |
mlh |
实体分类号(目录号) |
8 |
atype |
条目类型:0案卷,1文件(默认值),必填 |
2.2.1.1.2 返回参数
返回参数名称 |
参数描述 |
code |
返回的代码,0表示成功,1表示失败 |
count |
返回操作成功的数量 |
data |
返回的数据,包括档号的各个组成部分 |
msg |
获取档号成功或失败的消息 |
2.2.1.2 调用示例
2.2.1.2.1 Java调用示例
OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .addFormDataPart("c1","一级目录") .addFormDataPart("c2","二级目录") .addFormDataPart("c3","三级目录") .addFormDataPart("ccode","yanshi") .addFormDataPart("mlh","实体分类号") .addFormDataPart("qzh","全宗号") .addFormDataPart("atype","0") .build(); Request request = new Request.Builder() .url("localhost:8091/Archives2019_war_exploded/open_api/getDh") .method("POST", body) .addHeader("token", "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0") .build(); Response response = client.newCall(request).execute(); |
2.2.1.2.2 PHP调用示例
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'localhost:8091/Archives2019_war_exploded/open_api/getDh', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => array('c1' => '一级目录','c2' => '二级目录','c3' => '三级目录','ccode' => 'yanshi','mlh' => '实体分类号','qzh' => '全宗号','atype' => '0'), CURLOPT_HTTPHEADER => array( 'token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0' ), ));
$response = curl_exec($curl);
curl_close($curl); echo $response; |
2.2.1.2.3 C#调用示例
var client = new RestClient("localhost:8091/Archives2019_war_exploded/open_api/getDh"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("token", "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0"); request.AlwaysMultipartFormData = true; request.AddParameter("c1", "一级目录"); request.AddParameter("c2", "二级目录"); request.AddParameter("c3", "三级目录"); request.AddParameter("ccode", "yanshi"); request.AddParameter("mlh", "实体分类号"); request.AddParameter("qzh", "全宗号"); request.AddParameter("atype", "0"); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
2.2.1.2.4 Javascript-Jquery调用示例
var form = new FormData(); form.append("c1", "一级目录"); form.append("c2", "二级目录"); form.append("c3", "三级目录"); form.append("ccode", "yanshi"); form.append("mlh", "实体分类号"); form.append("qzh", "全宗号"); form.append("atype", "0");
var settings = { "url": "localhost:8091/Archives2019_war_exploded/open_api/getDh", "method": "POST", "timeout": 0, "headers": { "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0" }, "processData": false, "mimeType": "multipart/form-data", "contentType": false, "data": form };
$.ajax(settings).done(function (response) { console.log(response); }); |
2.2.1.3 返回值示例
{ "code": 0, "msg": "获取档号成功", "count": 0, "data": { "档号": "全宗号-实体分类号-1", "全宗号": "全宗号", "实体分类号": "实体分类号", "案卷号": "1" } } |
2.2.2 批量获取档号
2.2.2.1 参数说明
方法名称:getMultiDh。
2.2.2.1.1 提交参数
此处参数示例是常见档案归档过程中使用的参数,必填项不可缺失,其它著录项目如果没有值则可以不传递,如果有额外的字段也可以灵活添加。参数名称支持与档案系统里面字段一致的中文名称。
序号 |
参数名称 |
参数描述 |
1 |
token |
认证成功后获取的密钥,附加到header中,必填 |
2 |
ccode |
管理员提供的档案类别代码,必填 |
3 |
data |
包含多条数据信息的json |
2.2.2.1.2 返回参数
返回参数名称 |
参数描述 |
code |
返回的代码,0表示成功,1表示失败 |
count |
返回操作成功的数量 |
data |
返回的数据,包括匹配出的档号的各个组成部分 |
msg |
获取档号成功或失败的消息 |
2.2.2.2 调用示例
2.2.2.2.1 Java调用示例
OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .addFormDataPart("data","[ { \"ccode\": \"yanshi\", \"一级目录\": \"2021\", \"atype\": 1, \"实体分类号\": \"2021-JX11\", \"二级目录\": \"JX11\", \"学号\": \"01234 }, { \"ccode\": \"yanshi\", \"一级目录\": \"2021\", \"atype\": 1, \"实体分类号\": \"2021-JX11\", \"二级目录\": \"JX11\", \"学号\": \"01235
} ]") .build(); Request request = new Request.Builder() .url("localhost:8091/Archives2019_war_exploded/open_api/getMultiDh") .method("POST", body) .addHeader("token", "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2OTA1NTM3NDQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY5MDUyNDk0NCwianRpIjoiNGRkYWVjMTQtOWJhZi00ZTYzLWJlOTktY2YzYWJhNzFkNDkzIn0.J1v-gd2qk4iCVGR89F5QQUAeJ51zBcSvg9f0NqkG-qA") .build(); Response response = client.newCall(request).execute(); |
2.2.2.2.2 PHP调用示例
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'localhost:8091/Archives2019_war_exploded/open_api/getMultiDh', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => array('data' => '[ { "ccode": "yanshi", "一级目录": "2021", "atype": 1, "实体分类号": "2021-JX11", "二级目录": "JX11", "学号 "01234" }, { "ccode": "yanshi", "一级目录": "2021", "atype": 1, "实体分类号": "2021-JX11", "二级目录": "JX11", "学号 "01235 } ]'), CURLOPT_HTTPHEADER => array( 'token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2OTA1NTM3NDQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY5MDUyNDk0NCwianRpIjoiNGRkYWVjMTQtOWJhZi00ZTYzLWJlOTktY2YzYWJhNzFkNDkzIn0.J1v-gd2qk4iCVGR89F5QQUAeJ51zBcSvg9f0NqkG-qA' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
2.2.2.2.3 C#调用示例
var client = new RestClient("localhost:8091/Archives2019_war_exploded/open_api/getMultiDh"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("token", "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2OTA1NTM3NDQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY5MDUyNDk0NCwianRpIjoiNGRkYWVjMTQtOWJhZi00ZTYzLWJlOTktY2YzYWJhNzFkNDkzIn0.J1v-gd2qk4iCVGR89F5QQUAeJ51zBcSvg9f0NqkG-qA"); request.AlwaysMultipartFormData = true; request.AddParameter("data", "[ { \"ccode\": \"yanshi\", \"一级目录\": \"2021\", \"atype\": 1, \"实体分类号\": \"2021-JX11\", \"二级目录\": \"JX11\", \"学号\": \"01234 }, { \"ccode\": \"yanshi\", \"一级目录\": \"2021\", \"atype\": 1, \"实体分类号\": \"2021-JX11\", \"二级目录\": \"JX11\", \"学号\": \"01235\" } ]"); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content);
|
2.2.2.2.4 Javascript-Jquery调用示例
var form = new FormData(); form.append("data", "[ { \"ccode\": \"yanshi\", \"一级目录\": \"2021\", \"atype\": 1, \"实体分类号\": \"2021-JX11\", \"二级目录\": \"JX11\", \"学号: \"01234 }, { \"ccode\": \"yanshi\", \"一级目录\": \"2021\", \"atype\": 1, \"实体分类号\": \"2021-JX11\", \"二级目录\": \"JX11\", \"学号: \"01235\" } ]");
var settings = { "url": "localhost:8091/Archives2019_war_exploded/open_api/getMultiDh", "method": "POST", "timeout": 0, "headers": { "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2OTA1NTM3NDQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY5MDUyNDk0NCwianRpIjoiNGRkYWVjMTQtOWJhZi00ZTYzLWJlOTktY2YzYWJhNzFkNDkzIn0.J1v-gd2qk4iCVGR89F5QQUAeJ51zBcSvg9f0NqkG-qA" }, "processData": false, "mimeType": "multipart/form-data", "contentType": false, "data": form };
$.ajax(settings).done(function (response) { console.log(response); }); |
2.2.2.3 返回值示例
{ "code": 0, "msg": "获取档号成功", "count": 0, "data": [ { "实体分类号": "2021-JX11", "档号": "2021-JX11.0003", "文件号": "0003", "学号: "01234" }, { "实体分类号": "2021-JX11", "档号": "2021-JX11.0004", "文件号": "0004", "学号: "01235" } ] } |
2.2.3 传输文件封包
2.2.3.1 参数说明
方法名称:file2Archives。
2.2.3.1.1 提交参数
此处参数示例是常见档案归档过程中使用的参数,必填项不可缺失,其它著录项目如果没有值则可以不传递。
序号 |
参数名称 |
参数描述 |
1 |
token |
认证成功后获取的密钥,附加到header中,必填 |
2 |
fileData |
封包的文件对象,格式见附件,必填 |
3 |
ccode |
管理员提供的档案类别代码,必填 |
4 |
fileIdentifierCode |
唯一标识,用于验证是否重复提交,必填 |
2.2.3.1.2 返回参数
返回参数名称 |
参数描述 |
code |
返回的代码,0表示成功,1表示失败 |
count |
返回操作成功的数量 |
data |
返回的数据,空白 |
msg |
传输成功或失败的消息 |
2.2.3.2 调用示例
2.2.3.2.1 Java调用示例
OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .addFormDataPart("ccode","yanshi") .addFormDataPart("fileIdentifierCode","2021-JX16-191") .addFormDataPart("fileData","/F:/封装包/11.zip", RequestBody.create(MediaType.parse("application/octet-stream"), new File("/F:/封装包/11.zip"))) .build(); Request request = new Request.Builder() .url("localhost:8091/Archives2019_war_exploded/open_api/file2Archives") .method("POST", body) .addHeader("token", "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0") .build(); Response response = client.newCall(request).execute(); |
2.2.3.2.2 PHP调用示例
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'localhost:8091/Archives2019_war_exploded/open_api/file2Archives', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => array('ccode' => 'yanshi','fileIdentifierCode' => '2021-JX16-191','fileData'=> new CURLFILE('/F:/封装包/11.zip')), CURLOPT_HTTPHEADER => array( 'token: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
2.2.3.2.3 C#调用示例
var client = new RestClient("localhost:8091/Archives2019_war_exploded/open_api/file2Archives"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("token", "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0"); request.AddParameter("ccode", "yanshi"); request.AddParameter("fileIdentifierCode", "2021-JX16-191"); request.AddFile("fileData", "/F:/封装包/11.zip"); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
2.2.3.2.4 Javascript-Jquery调用示例
var form = new FormData(); form.append("ccode", "yanshi"); form.append("fileIdentifierCode", "2021-JX16-191"); form.append("fileData", fileInput.files[0], "/F:/封装包/11.zip");
var settings = { "url": "localhost:8091/Archives2019_war_exploded/open_api/file2Archives", "method": "POST", "timeout": 0, "headers": { "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkYmEiLCJwYXNzd29yZCI6ImU0MjcwMTBlZmJmMWUyNzkiLCJ1bml0aWQiOiJkYWciLCJleHAiOjE2ODkyNDM4MjQsInVzZXJpZCI6ImRiYSIsImlhdCI6MTY4OTIxNTAyNCwianRpIjoiNmU0NzQwYzQtNjIxMC00NjY1LTg3OWItMWFmYjIyNDk4NDI5In0.ss3AdAFg-uciyM3iLGqaVDgJ56cuLlK2-ItHvP0gw-0" }, "processData": false, "mimeType": "multipart/form-data", "contentType": false, "data": form };
$.ajax(settings).done(function (response) { console.log(response); }); |
2.2.3.3 返回值示例
{ "code": 0, "msg": "档案封装包提交成功", "count": 0, "data": null } |
2.2.4 常见错误代码
返回错误代码值 |
原因描述 |
-1 |
文件号及案卷号都为空 |
-2 |
案卷号非数字 |
-3 |
文件号非数字 |
-4 |
件内号非数字 |
2.2.5 归档结果的异步通知接口
此接口需要由业务系统提供,档案系统主动调用。此接口可用IP等进行授权不得使用账号密码等进行二次验证。
参数名称 |
参数描述 |
fileIdentifierCode |
传递归档包时的唯一标识 |
code |
是否成功归档,0表示成功,1表示失败 |
msg |
接收档案系统返回的消息,如退回原因 |
verify |
根据双方约定规则生成的加密字符串 =md5(fileIdentifierCode+code+msg+当天日期+握手key) |
握手key由双方共同约定。
3 业务系统数据归档步骤简述(以OA为例)
3.1 档案系统提供接口参数
参数包括Appkey、appsecret、ccode、baseUrl四个。
3.2 获取token
地址为baseUrl/gettoken。
3.3 获取档号
如果档号已经确定好了则不需要获取。
地址为baseUrl/getDh。
需要将第一步获得的token放到header里面。
3.4 传输文件封包
地址为baseUrl/file2Archives。
封包内容包括元数据xml、正文、附件、处理单等(需要将第一步获得的token放到header里面),封包文件格式为zip格式。
注意元数据.xml中需要包括获取档号步骤获取到的档号相关信息。
(注意查看错误代码表)
3.5 增加归档结果的异步通知接口接收归档情况
==文档结束==
