From ac4341ea6b66ae02427d39d35f41d42d78b2eb2e Mon Sep 17 00:00:00 2001
From: Junjie <fallin.jie@qq.com>
Date: 星期五, 14 二月 2025 10:08:32 +0800
Subject: [PATCH] #
---
zy-asrs-openapi/src/main/webapp/views/md/introduce.md | 359 ++++-------------------------------------------------------
1 files changed, 26 insertions(+), 333 deletions(-)
diff --git a/zy-asrs-openapi/src/main/webapp/views/md/introduce.md b/zy-asrs-openapi/src/main/webapp/views/md/introduce.md
index c975f05..a9e1b03 100644
--- a/zy-asrs-openapi/src/main/webapp/views/md/introduce.md
+++ b/zy-asrs-openapi/src/main/webapp/views/md/introduce.md
@@ -1,44 +1,14 @@
+# API骞冲彴鎺ュ彛鏂囨。 v1.0
-# AA鍏徃BC骞冲彴鎺ュ彛鏂囨。 v3.2.0
+## 瑙勮寖璇存槑
-## 1 瑙勮寖璇存槑
+### 閫氫俊鍗忚
+HTTP鍗忚
-### 1.1 閫氫俊鍗忚
+### 璇锋眰鏂规硶
+鎺ュ彛鏀寔POST鏂规硶鍙戣捣璇锋眰銆�
-HTTPS鍗忚[HTTPS鍗忚](generateSign.html)
-
-### 1.2 璇锋眰鏂规硶
-鎵�鏈夋帴鍙ｅ彧鏀寔POST鏂规硶鍙戣捣璇锋眰銆�
-
-### 1.3 瀛楃缂栫爜
-HTTP閫氳鍙婃姤鏂嘊ASE64缂栫爜鍧囬噰鐢║TF-8瀛楃闆嗙紪鐮佹牸寮忋��
-
-### 1.4 鏍煎紡璇存槑
-鍏冪礌鍑虹幇瑕佹眰璇存槑锛�
-
-绗﹀彿 |璇存槑
-:----: |:---
-R |鎶ユ枃涓鍏冪礌蹇呴』鍑虹幇锛圧equired锛�
-O |鎶ユ枃涓鍏冪礌鍙�夊嚭鐜帮紙Optional锛�
-C |鎶ユ枃涓鍏冪礌鍦ㄤ竴瀹氭潯浠朵笅鍑虹幇锛圕onditional锛�
-
-### 1.5 鎶ユ枃瑙勮寖璇存槑
-
-1. 鎶ユ枃瑙勮寖浠呴拡瀵逛氦鏄撹姹傛暟鎹繘琛屾弿杩帮紱
-
-2. 鎶ユ枃瑙勮寖涓姹傛姤鏂囩殑鍐呭涓篐ttps璇锋眰鎶ユ枃涓璕equestData鍊肩殑鏄庢枃鍐呭锛�
-
-3. 鎶ユ枃瑙勮寖鍒嗕负璇锋眰鎶ユ枃鍜屽搷搴旀姤鏂囥�傝姹傛姤鏂囨弿杩扮敱鍙戣捣鏂癸紝鍝嶅簲鎶ユ枃鐢辨姤鏂囨帴鏀舵柟鍝嶅簲銆�
-
-### 1.6 璇锋眰鎶ユ枃缁撴瀯
-鎺ュ彛鍙帴鏀朵袱涓弬鏁� **RequestData** 鍜� **SignData** 锛屽叾涓璕equestData鐨勫�间负璇锋眰鍐呭锛孲ignData鐨勫�间负绛惧悕鍐呭銆�
-
-#### 1.6.1 鍙傛暟璇存槑
-**RequestData锛堣姹傚唴瀹癸級锛�** 鍏舵槑鏂囦负姣忔璇锋眰鐨勫叿浣撳弬鏁帮紝閲囩敤 JSON 鏍煎紡锛屼緷娆＄粡杩� DES 鍔犲瘑锛堜互UTF-8缂栫爜銆丅ASE64缂栫爜杈撳嚭缁撴灉锛夊拰 URLEncode 鍚庯紝浣滀负 RequestData 鐨勫�笺��
-
-**SignData锛堢鍚嶅唴瀹癸級锛�** 璇锋眰鍙傛暟锛堟槑鏂囷級鐨凪D5鍔犲瘑瀛楃涓诧紝鐢ㄤ簬鏍￠獙RequestData鏄惁鍚堟硶銆�
-
-#### 1.6.2 璇锋眰鍐呭锛圧equestData锛夋槑鏂囩粨鏋勮鏄�
+### 璇锋眰鍐呭缁撴瀯璇存槑
閲囩敤JSON鏍煎紡锛屽叾涓寘鍚獺eader锛堝叕鏈夊弬鏁帮級銆丅ody锛堢鏈夊弬鏁帮級鑺傜偣锛�
@@ -51,313 +21,36 @@
鍏叡鍙傛暟锛圚eader锛夋槸鐢ㄤ簬鏍囪瘑浜у搧鍙婃帴鍙ｉ壌鏉冪殑鍙傛暟锛屾瘡娆¤姹傚潎闇�瑕佹惡甯﹁繖浜涘弬鏁帮細
-鍙傛暟鍚嶇О |绫诲瀷 |鍑虹幇瑕佹眰 |鎻忚堪
+鍙傛暟鍚嶇О |绫诲瀷 |鍙傛暟瑕佹眰 |鎻忚堪
:---- |:--- |:------ |:---
-Token |string |R |鐢ㄦ埛鐧诲綍鍚巘oken锛屾病鏈夌櫥褰曞垯涓虹┖瀛楃涓�
-Version |string |R |鎺ュ彛鐗堟湰鍙�
-SystemId |int |R |鏈烘瀯鍙凤紝璇锋眰鐨勭郴缁烮d
-Timestamp |long |R |褰撳墠UNIX鏃堕棿鎴�
+appkey |string | 蹇呭～ |瀵嗛挜绠＄悊涓敓鎴恆ppkey
-#### 1.6.3 鏍￠獙娴佺▼锛�
-鏈嶅姟绔帴鏀跺埌璇锋眰鍚庨鍏堝RequestData杩涜DES瑙ｅ瘑鍑篔SON瀛楃涓诧紝鐒跺悗瀵笿SON瀛楃涓茶繘琛孧D5鍔犲瘑锛屽姞瀵嗗悗鐨勫�间笌璇锋眰涓殑SignData鍊艰繘琛屽姣旓紝濡傚姣旈�氳繃锛岃涓哄悎娉曡姹傦紝鍚﹀垯瑙嗕负闈炴硶璇锋眰銆�
+### 绛惧悕鏍￠獙娴佺▼锛�
+鏈嶅姟绔帴鏀跺埌璇锋眰鍚庨鍏堝Body鍓旈櫎sign鍙傛暟锛屽苟娣诲姞signKey鍊硷紝鍐嶅Bode鐨刱ey鍊艰繘琛岃嚜鐒舵帓搴忋�傜劧鍚庡JSON瀛楃涓茶繘琛孧D5鍔犲瘑锛屽姞瀵嗗悗鐨勫�间笌Body涓殑sign鍊艰繘琛屽姣旓紝濡傚姣旈�氳繃锛岃涓哄悎娉曡姹傦紝鍚﹀垯瑙嗕负闈炴硶璇锋眰銆�
-**DES鍔犲瘑/瑙ｅ瘑鍑芥暟绀轰緥锛�**
-
-C#鐗堬細
-
-```
-/// <summary>
-/// 杩涜DES鍔犲瘑銆�
-/// </summary>
-/// <param name="decryptString">瑕佸姞瀵嗙殑瀛楃涓层��</param>
-/// <param name="secretKey">瀵嗛挜锛屼笖蹇呴』涓�8浣嶃��</param>
-/// <returns>浠ase64鏍煎紡杩斿洖鐨勫姞瀵嗗瓧绗︿覆銆�</returns>
-public static string DesEncrypt(string decryptString, string secretKey)
-{
- using (DESCryptoServiceProvider des = new DESCryptoServiceProvider())
- {
- byte[] inputByteArray = Encoding.UTF8.GetBytes(decryptString);
- des.Key = Encoding.ASCII.GetBytes(secretKey);
- des.IV = Encoding.ASCII.GetBytes(secretKey);
- MemoryStream ms = new MemoryStream();
- using (CryptoStream cs = new CryptoStream(ms, des.CreateEncryptor(), CryptoStreamMode.Write))
- {
- cs.Write(inputByteArray, 0, inputByteArray.Length);
- cs.FlushFinalBlock();
- cs.Close();
- }
- string str = Convert.ToBase64String(ms.ToArray());
- ms.Close();
- return str;
- }
-}
-
-/// <summary>
-/// 杩涜DES瑙ｅ瘑銆�
-/// </summary>
-/// <param name="encryptedString">瑕佽В瀵嗙殑浠ase64</param>
-/// <param name="secretKey">瀵嗛挜锛屼笖蹇呴』涓�8浣嶃��</param>
-/// <returns>宸茶В瀵嗙殑瀛楃涓层��</returns>
-public static string DesDecrypt(string encryptedString, string secretKey)
-{
- byte[] inputByteArray = Convert.FromBase64String(encryptedString);
- using (DESCryptoServiceProvider des = new DESCryptoServiceProvider())
- {
- des.Key = Encoding.ASCII.GetBytes(secretKey);
- des.IV = Encoding.ASCII.GetBytes(secretKey);
- MemoryStream ms = new MemoryStream();
- using (CryptoStream cs = new CryptoStream(ms, des.CreateDecryptor(), CryptoStreamMode.Write))
- {
- cs.Write(inputByteArray, 0, inputByteArray.Length);
- cs.FlushFinalBlock();
- cs.Close();
- }
- string str = Encoding.UTF8.GetString(ms.ToArray());
- ms.Close();
- return str;
- }
-}
-```
-
-JAVA鐗堬細
-
-```
-/* DES瑙ｅ瘑 */
-public static String decrypt(String message, String key) throws Exception {
-
- byte[] bytesrc = Base64.decode(message);
- //convertHexString(message);
- Cipher cipher = Cipher.getInstance("DES/CBC/PKCS5Padding");
- DESKeySpec desKeySpec = new DESKeySpec(key.getBytes("UTF-8"));
- SecretKeyFactory keyFactory = SecretKeyFactory.getInstance("DES");
- SecretKey secretKey = keyFactory.generateSecret(desKeySpec);
- IvParameterSpec iv = new IvParameterSpec(key.getBytes("UTF-8"));
- cipher.init(Cipher.DECRYPT_MODE, secretKey, iv);
- byte[] retByte = cipher.doFinal(bytesrc);
- return new String(retByte);
-}
-
-
-/* DES鍔犲瘑 */
-public static byte[] encrypt(String message, String key) throws Exception {
- Cipher cipher = Cipher.getInstance("DES/CBC/PKCS5Padding");
- DESKeySpec desKeySpec = new DESKeySpec(key.getBytes("UTF-8"));
- SecretKeyFactory keyFactory = SecretKeyFactory.getInstance("DES");
- SecretKey secretKey = keyFactory.generateSecret(desKeySpec);
- IvParameterSpec iv = new IvParameterSpec(key.getBytes("UTF-8"));
- cipher.init(Cipher.ENCRYPT_MODE, secretKey, iv);
- return cipher.doFinal(message.getBytes("UTF-8"));
-}
-```
-
-#### 1.6.4 DES瀵嗛挜
-
-娴嬭瘯鐜锛歛z2ih1uY
-
-鐢熶骇鐜锛氬彟澶栨彁渚涖��
-
-#### 1.6.5 璇锋眰鎶ユ枃绀轰緥
+### 璇锋眰鎶ユ枃绀轰緥
璇锋眰鍐呭鏄庢枃锛�
```
{
- "Header":{
- "Token":"2366CF921FAD44CCBB07FF9CD02FC90E",
- "Version":"3.2.0",
- "SystemId":100,
- "Timestamp":1502870664
- },
- "Body":{
- "Mobile":"18520322032",
- "Password":"acb000000"
- }
-}
-
-```
-
-璇锋眰鎶ユ枃绀轰緥锛�
-
-```
-url?RequestData=UFAYIRF21XzGoaAaEU54qoDBYaFkT2KbRpWxKZuqqltApdIneF7AjlEArPLsg3%2Fo1Pu7FHFmsKZn%0A9KJb%2BGuwx0P%2F3jzv2TgwUpVtgwEdfd0vIRfqEF4jCouldaxxVBjbHvd%2F08pUoYJDNZJLvNrJ%2BsK4%0A79de92T0Cyu4hKNMUPtVI7Tp0IC%2BBw%3D%3D&SignData=0865c7d625f90d3bb5457f5d9ac3725d
-```
-
-### 1.7 鍝嶅簲鎶ユ枃缁撴瀯
-#### 1.7.1 缁撴瀯璇存槑
-鎵�鏈夋帴鍙ｅ搷搴斿潎閲囩敤JSON鏍煎紡锛屽鏃犵壒娈婅鏄庯紝姣忔璇锋眰鐨勮繑鍥炲�间腑锛岄兘鍖呭惈涓嬪垪瀛楁锛�
-
-鍙傛暟鍚嶇О |绫诲瀷 |鍑虹幇瑕佹眰 |鎻忚堪
-:---- |:--- |:------ |:---
-Code |int |R |鍝嶅簲鐮侊紝浠ｇ爜瀹氫箟璇疯鈥滈檮褰旳 鍝嶅簲鍚楄鏄庘��
-Msg |string |R |鍝嶅簲鎻忚堪
-Data |object |R |姣忎釜鎺ュ彛鐗规湁鐨勫弬鏁帮紝璇﹁姣忎釜鎺ュ彛瀹氫箟
-
-
-#### 1.7.2 鍝嶅簲鎶ユ枃绀轰緥
-
-```
-{
- "Code":200,
- "Msg":"璋冪敤鎴愬姛",
- "Data":{
- "Channel":"A10086",
- "Type":7004
- }
+ "orderNo": 2024010311062541,
+ "orderType": 1,
+ "orderDetails": [
+ {
+ "orderNo": 2024010311062541,
+ "matnr": "test001",
+ "anfme": 10
+ }
+ ],
+ "sign": "8a7036cfe218e12f50f9107e9eb4a437"
}
```
-
-## 2. 鎺ュ彛瀹氫箟
-
-### 2.1 瀵嗙爜鐧诲綍
-- **鎺ュ彛璇存槑锛�** 瀵嗙爜鐧诲綍
-- **鎺ュ彛鍦板潃锛�** /account/signin
-
-#### 2.1.1 璇锋眰鍙傛暟
-
-鍙傛暟鍚嶇О |绫诲瀷 |鍑虹幇瑕佹眰 |鎻忚堪
-:---- |:--- |:------ |:---
-Header | |R |璇锋眰鎶ユ枃澶�
- Token |string |R |鐢ㄦ埛鐧诲綍鍚巘oken锛屾病鏈夌櫥褰曞垯涓虹┖瀛楃涓�
- Version |string |R |鎺ュ彛鐗堟湰鍙�
- SystemId |int |R |鏈烘瀯鍙凤紝璇锋眰鐨勭郴缁烮d
- Timestamp |long |R |褰撳墠UNIX鏃堕棿鎴�
-Body | |R |
- Mobile |string |R |鎵嬫満鍙�
- Password |string |R |瀵嗙爜
-
-
-璇锋眰绀轰緥锛�
+### 绛夊緟绛惧悕鎶ユ枃绀轰緥
+绛夊緟绛惧悕鎶ユ枃(宸插墧闄ign鍊笺�佸凡娣诲姞signKey鍊煎苟瀵筴ey杩涜鑷劧鎺掑簭)锛�
```
-{
- "Header":{
- "Token":"",
- "Version":"3.2.0",
- "SystemId":100,
- "Timestamp":1502870664
- },
- "Body":{
- "Mobile":"18520322032",
- "Password":"acb000000"
- }
-}
-
+{"orderDetails":[{"orderNo":"2024010311062541","matnr":"test001","anfme":10.0}],"orderType":1,"orderNo":"2024010311062541","signKey":"29823ebbfbc2f04a5fbb407ea926832f"}
```
-
-
-#### 2.1.2 杩斿洖缁撴灉
-
-鍙傛暟鍚嶇О |绫诲瀷 |鍑虹幇瑕佹眰 |鎻忚堪
-:---- |:--- |:------ |:---
-Code |int |R |鍝嶅簲鐮侊紝浠ｇ爜瀹氫箟璇疯鈥滈檮褰旳 鍝嶅簲鍚楄鏄庘��
-Msg |string |R |
-Data |object |R |
- UserId |string |R |鐢ㄦ埛Id
-
-绀轰緥锛�
-
-```
-{
- "Code":200,
- "Msg":"鐧诲綍鎴愬姛",
- "Data":{
- "UserId":"7D916C7283434955A235C17DD9B71C64"
- }
-}
-```
-
-
-
-### 2.2 鑾峰彇鐧诲綍鐢ㄦ埛淇℃伅
-- **鎺ュ彛璇存槑锛�** 鑾峰彇鐧诲綍鐢ㄦ埛淇℃伅
-- **鎺ュ彛鍦板潃锛�** /account/profile
-
-#### 2.2.1 璇锋眰鍙傛暟
-
-鍙傛暟鍚嶇О |绫诲瀷 |鍑虹幇瑕佹眰 |鎻忚堪
-:---- |:--- |:------ |:---
-Header | |R |璇锋眰鎶ユ枃澶�
- Token |string |R |鐢ㄦ埛鐧诲綍鍚巘oken锛屾病鏈夌櫥褰曞垯涓虹┖瀛楃涓�
- Version |string |R |鎺ュ彛鐗堟湰鍙�
- SystemId |int |R |鏈烘瀯鍙凤紝璇锋眰鐨勭郴缁烮d
- Timestamp |long |R |褰撳墠UNIX鏃堕棿鎴�
-Body | |R |
-
-
-
-璇锋眰绀轰緥锛�
-
-```
-
-{
- "Header":{
- "Token":"CA64A439E7C344B0BA7F5C825E17C7AB",
- "Version":"3.2.0",
- "SystemId":100,
- "Timestamp":1502870664
- },
- "Body":null
-}
-
-```
-
-
-#### 2.2.2 杩斿洖缁撴灉
-
-鍙傛暟鍚嶇О |绫诲瀷 |鍑虹幇瑕佹眰 |鎻忚堪
-:---- |:--- |:------ |:---
-Code |int |R |鍝嶅簲鐮侊紝浠ｇ爜瀹氫箟璇疯鈥滈檮褰旳 鍝嶅簲鍚楄鏄庘��
-Msg |string |R |
-Data |object |R |
- UserId |string |R |鐢ㄦ埛Id
- RealName |string |R |濮撳悕
- ImageUrl |string |R |澶村儚
- Score |int |R |绉垎
- Nickname |string |R |鏄电О
- Sex |int |R |鎬у埆锛�0-鏈煡銆�1-鐢枫��2-濂�
- Title |string |R |澶磋
-
-
-绀轰緥锛�
-
-```
-{
- "Code":200,
- "Msg":"澶勭悊鎴愬姛",
- "Data":{
- "UserId":"7D916C7283434955A235C17DD9B71C64",
- "RealName":"寮犱笁",
- "ImageUrl":"https://img.xx.net/afdicew8751.png",
- "Score":4732,
- "Nickname":"寮犲啝鏉庢埓",
- "Sex":1,
- "Title":"渚犲Lv4"
- }
-}
-```
-
-
-## 3 闄勫綍A 鍝嶅簲鐮佽鏄�
-
-鍝嶅簲鐮� |璇存槑
-:---- |:---
-200 |澶勭悊鎴愬姛
-301 |瑙ｆ瀽鎶ユ枃閿欒
-302 |鏃犳晥璋冪敤鍑瘉
-303 |鍙傛暟涓嶆纭�
-500 |绯荤粺鍐呴儴閿欒
-999 |澶勭悊澶辫触
-
-
-## 4 闄勫綍B 甯佺
-
-甯佺 |璇存槑
-:---- |:---
-RMB |浜烘皯甯�
-HKD |娓竵
-JPY |鏃ュ厓
-TWD |鏂板彴甯�
-USD |缇庡厓
-VND |瓒婂崡鐩�
-THB |娉伴摙
\ No newline at end of file
+灏嗕笂闈㈢殑鎶ユ枃杩涜md5鍔犲瘑寰楀嚭鍊间负锛歚``8a7036cfe218e12f50f9107e9eb4a437```
\ No newline at end of file
--
Gitblit v1.9.1