cepm
/
ecologyDoc
Watch 12
Star 0
Fork 0
Code Pull Requests 0 Releases 0 Activity
Browse Source

人脸识别接口文档

pull/1/head
周雪成 3 years ago
parent
cecb031a26
commit
df7fb6858f
2 changed files with 150 additions and 2 deletions
Split View Show Diff Stats
  1. 148
    0
      AI/人脸识别接口文档.md
  2. 2
    2
      core/Token使用文档.md

+ 148
- 0
AI/人脸识别接口文档.md View File 

@@ -0,0 +1,148 @@
1 
+### 注意事项
2 
+1. 以下接口请求头必须加入`Authorization`，值为授权token([如何获取token](../core/Token使用文档.md))
3 
+2. 接口数据为 `Json`
4 
+
5 
+### 人脸比对
6 
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/match` <br>
7 
+
8 
+
9 
+| 请求参数  | 类型 | 是否必填 | 说明 |
10 
+| --- | --- | --- | --- |
11 
+| async | boolean| 否 | 是否开启异步反馈模式，默认为false |
12 
+| liveCode | String| 否 | 传入对比数据为视频并选择LIP模式时必传，参数为数字验证码接口获取的参数 |
13 
+| --- | --- | --- | --- |
14 
+| image | -| - | 作为对比参照的客户照片 |
15 
+| type | String| 是 | 固定传"image" |
16 
+| origin | String| 否 | image的数据类型。<br/> base64字符串：self<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>图片链接：uri <br/>默认为 self |
17 
+| data | String| 是 | 图片数据（base64，文件服务器文件路径或链接） |
18 
+| --- | --- | --- | --- |
19 
+| faceData | -| - | 需要比对的客户照片或视频 |
20 
+| type | String| 是 | 照片：image <br/> 视频：video |
21 
+| videoType | String| 是 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字|
22 
+| origin | String| 否 | faceData的数据类型。<br/> base64字符串：self<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self |
23 
+| data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
24 
+| --- | --- | --- | --- |
25 
+
26 
+
27 
+| 返回参数  | 类型 | 是否比返 | 说明 |
28 
+| --- | --- | --- | --- |
29 
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
30 
+| errmsg | String | 否 | errcode不为0时有值 |
31 
+| --- | --- | --- | --- |
32 
+| data | - | - | 包含数据见下 |
33 
+| status | String | 是 | “SUCCESS”为业务成功 |
34 
+| traceNo | String | 是 | 当前业务的唯一id |
35 
+| result | String | 是 | 业务结果 |
36 
+| result->isSccess | String | 是 | true：识别成功<br>false：识别失败 |
37 
+| result->score | String | 否 | 匹配分数，以供参考 |
38 
+| --- | --- | --- | --- |
39 
+
40 
+请求示例
41 
+
42 
+```
43 
+{
44 
+
45 
+}
46 
+```
47 
+
48 
+返回示例
49 
+
50 
+```
51 
+{
52 
+    "errcode":0,
53 
+    "data":{
54 
+
55 
+    },
56 
+    "errmsg":"SUCCESS"
57 
+}
58 
+```
59 
+
60 
+### 身份验证
61 
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/match/idno`
62 
+
63 
+| 请求参数  | 类型 | 是否必填 | 说明 |
64 
+| --- | --- | --- | --- |
65 
+| async | boolean| 否 | 是否开启异步反馈模式，默认为false |
66 
+| idNum | String| 是 | 验证人的身份证号 |
67 
+| name | String| 是 | 验证人的姓名 |
68 
+| liveCode | String| 是 | 数字验证码，选择LIP模式时必传 |
69 
+| --- | --- | --- | --- |
70 
+| faceData | -| - | 需要比对的客户照片或视频 |
71 
+| type | String| 是 | 照片：image <br/> 视频：video |
72 
+| videoType | String| 是 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字|
73 
+| origin | String| 否 | faceData的数据类型。<br/> base64字符串：self<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self |
74 
+| data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
75 
+| --- | --- | --- | --- |
76 
+
77 
+| 返回参数  | 类型 | 是否比返 | 说明 |
78 
+| --- | --- | --- | --- |
79 
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
80 
+| errmsg | String | 否 | errcode不为0时有值 |
81 
+| --- | --- | --- | --- |
82 
+| data | - | - | 包含数据见下 |
83 
+| status | String | 是 | “SUCCESS”为业务成功 |
84 
+| traceNo | String | 是 | 当前业务的唯一id |
85 
+| result | String | 是 | 业务结果 |
86 
+| result->isSccess | String | 是 | true：识别成功<br>false：识别失败 |
87 
+| result->score | String | 否 | 匹配分数，以供参考 |
88 
+| --- | --- | --- | --- |
89 
+
90 
+请求示例
91 
+
92 
+```
93 
+{
94 
+
95 
+}
96 
+```
97 
+
98 
+返回示例
99 
+
100 
+```
101 
+{
102 
+    "errcode":0,
103 
+    "data":{
104 
+
105 
+    },
106 
+    "errmsg":"SUCCESS"
107 
+}
108 
+```
109 
+
110 
+### 获取数字验证码
111 
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/match/validateData` <br>
112 
+> 数据格式 `Json`
113 
+
114 
+| 请求参数  | 类型 | 是否必填 | 说明 |
115 
+| --- | --- | --- | --- |
116 
+| async | boolean| 否 | 是否开启异步反馈模式，默认为false |
117 
+
118 
+| 返回参数  | 类型 | 是否比返 | 说明 |
119 
+| --- | --- | --- | --- |
120 
+| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
121 
+| errmsg | String | 否 | errcode不为0时有值 |
122 
+| --- | --- | --- | --- |
123 
+| data | - | - | 包含数据见下 |
124 
+| status | String | 是 | “SUCCESS”为业务成功 |
125 
+| traceNo | String | 是 | 当前业务的唯一id |
126 
+| result | String | 是 | 业务结果 |
127 
+| result->code | String | 否 | 数字验证码 |
128 
+| --- | --- | --- | --- |
129 
+
130 
+请求示例
131 
+
132 
+```
133 
+{
134 
+    "refreshToken":""
135 
+}
136 
+```
137 
+
138 
+返回示例
139 
+
140 
+```
141 
+{
142 
+    "errcode":0,
143 
+    "data":{
144 
+        "accessToken":""
145 
+    },
146 
+    "errmsg":"SUCCESS"
147 
+}
148 
+```

+ 2
- 2
core/Token使用文档.md View File 

@@ -6,7 +6,7 @@
6 6 
 ![Token](./image/token.png)
7 7
8 8 
 ### getVirtualToken 获取token
9 
-> 请求方式  ` POST http://172.20.109.105:7007/core/auth/getVirtualToken`
9 
+> 请求方式  ` POST http://172.20.109.105:7007/core/auth/getVirtualToken` <br>
10 10 
 > 数据格式 `Json`
11 11
12 12 
 | 请求参数  | 类型 | 是否必填 | 说明 |
 
@@ -47,7 +47,7 @@
47 47 
 ```
48 48
49 49 
 ### refreshToken 获取token
50 
-> 请求方式  ` POST http://172.20.109.105:7007/core/auth/refreshToken`
50 
+> 请求方式  ` POST http://172.20.109.105:7007/core/auth/refreshToken` <br>
51 51 
 > 数据格式 `Json`
52 52
53 53 
 | 请求参数  | 类型 | 是否必填 | 说明 |

Write Preview
Loading…
Cancel
Save