api_doc.py
6.69 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
base_part = '''
swagger: "2.0"
info:
title: 接口文档
description: 宝马ocr/biz_logic接口文档
version: 1.0.0
host: "staging-bmw-ocr.situdata.com"
basePath: "/"
tags:
- name: info
description: 比对信息
schemes:
- "https"
security:
- OAuth2: []
'''
# scheme: oauth
security_definitions = '''
OAuth2:
type: oauth2
flow: application
description: >
This API uses OAuth 2 with the application(clientCredentials) grant flow.
client_id=sMlciTkppsMzARwHpCVarm5q7DP2Vucj3ny8JFhw
client_secret=WNoOilDx140ZLcenDKfsnikv7S2LIFs60DciYoqnrZaYLqYsKpcmt7mJIL69o9AEf84uQvRnS3K2UioxfjNyImjR4UOyXbDcF6qYgTLC4KDVByKFdVhKfrn2Lc4q4BNW
scopes=write
tokenUrl: https://staging-bmw-ocr.situdata.com/api/oauth/token/
scopes:
write: Grants write access
'''
responses = '''
ErrorResponse:
description: 调用异常, 具体情况请参考`HTTP`状态码和`code`字段
schema:
$ref: '#/definitions/ApiResponse'
NoContent:
description: 后台接收请求,但是没有响应内容
schema:
$ref: '#/definitions/ApiResponse'
'''
parameters = ''
definitions = '''
individualCusInfo:
type: object
required: [applicantType, idType, customerChineseName, idNum, idExpiryDate, dateOfBirth, companyName, registeredCapital, selfEmployedSubType]
properties:
applicantType:
description: applicantType
type: string
example: COAPP
enum: [COAPP, CUSTR, GAUTR1, GAUTR2]
idType:
description: idType
type: string
example: ITARI
enum: [ITARI, ITHKM, ITPRC, ITPSP, ITRES, ITTID, ITUSC, ITCCU]
secondIdType:
description: secondIdType
type: string
example: ITARI
enum: [ITARI, ITHKM, ITPRC, ITPSP, ITRES, ITTID]
customerChineseName:
description: customerChineseName
type: string
example: 李四
idNum:
description: idNum
type: string
example: 111111199404251111
secondIdNum:
description: secondIdNum
type: string
example: 111111199404251111
idExpiryDate:
description: idExpiryDate
type: string
format: date
example: "2027-04-30"
dateOfBirth:
description: dateOfBirth
type: string
format: date
example: "2027-04-30"
companyName:
description: companyName
type: string
example: 北京思图场景数据科技服务有限公司
registeredCapital:
description: registeredCapital
type: number
format: float
example: 1234.56
selfEmployedSubType:
description: selfEmployedSubType
type: string
example: CSIBM
enum: [CSIBM, CSOTH, CSSME]
Comparison:
type: object
required: [content]
properties:
content:
description: 比对内容信息
type: object
required: [uniqSeq, applicationId, applicationEntity, customerType, applicationVersion, vehicleStatus, comments, individualCusInfo]
properties:
uniqSeq:
description: uniqSeq
type: string
example: 201809301905121000
applicationId:
description: applicationId
type: string
example: CH-B100000123
applicationEntity:
description: applicationEntity
type: string
example: HIL
enum: [AFC, HIL]
customerType:
description: customerType
type: string
example: TCCOR
enum: [TCCOR, TCDAS, TCFRE, TCIAS, TCIND, TCSEP, TCURE]
applicationVersion:
description: applicationVersion
type: integer
example: 0
vehicleStatus:
description: vehicleStatus
type: string
example: PCUSD
enum: [PCUSD, PCNEW]
comments:
description: comments
type: array
items:
type: string
individualCusInfo:
description: individualCusInfo
type: array
items:
$ref: "#/definitions/individualCusInfo"
usedCarInfo:
description: usedCarInfo
type: object
required: [vinNo, manufactureDate, firstRegistrationDate]
properties:
vinNo:
description: vinNo
type: string
example: LBVSFJSDLFJLSDJF
manufactureDate:
description: manufactureDate
type: string
format: date
example: "2027-04-30"
firstRegistrationDate:
description: firstRegistrationDate
type: string
format: date
example: "2027-04-30"
corporateCusInfo:
description: corporateCusInfo
type: object
required: [customerChineseName, legalRepName, idNum, businessLicenseNo, taxRegistrationCode, incorporationDate, businessLicenseDueDate, capitalRegAmount]
properties:
customerChineseName:
description: customerChineseName
type: string
example: 北京思图场景数据科技服务有限公司
legalRepName:
description: legalRepName
type: string
example: 李六
idNum:
description: idNum
type: string
example: MA007438143XJ1P
businessLicenseNo:
description: businessLicenseNo
type: string
example: MA007438143XJ1P
taxRegistrationCode:
description: taxRegistrationCode
type: string
example: MA007438143XJ1P
incorporationDate:
description: incorporationDate
type: string
format: date
example: "2027-04-30"
businessLicenseDueDate:
description: businessLicenseDueDate
type: string
format: date
example: "2027-04-30"
capitalRegAmount:
description: capitalRegAmount
type: number
format: float
example: 1234.56
ApiResponse:
description: 响应对象,code字段用于表示响应的状态; data字段用于存放响应内容
type: object
required: [code, msg]
properties:
code:
type: integer
format: uint8
description: '0: success
1: need login
2: invalid params
3: internal error
4: object not exist
5: async wait
6: no permission
7: illegal operation'
example: 0
enum: [0, 1, 2, 3, 4, 5, 6, 7]
msg:
type: string
example: success
data:
type: object
'''