data/zh_cn/safconsole/2021-01-12/api-docs.php


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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'safconsole',
        'version' => '2021-01-12',
    ],
    'directories' => [
        [
            'id' => 236784,
            'title' => '样本管理',
            'type' => 'directory',
            'children' => [
                'RevokeFeedback',
                'SendFeedback',
                'UploadSampleApi',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'RevokeFeedback' => [
            'summary' => '用于风险识别服务的社群样本外部删除。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'delete',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '79133',
                'abilityTreeNodes' => [
                    'FEATUREsafT73ZWM',
                ],
            ],
            'parameters' => [
                [
                    'name' => 'SampleType',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '样本类型。手机号类型样本需传入PHONE，邮箱类型样本需传入EMAIL，账户类型样本需传入ACCOUNT',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => 'PHONE'."\n",
                    ],
                ],
                [
                    'name' => 'Value',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '样本值。',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '10000000000',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Code' => [
                                'description' => '接口状态或POP错误码。取值说明如下：2xx：成功。3xx：重定向。4xx：请求错误。5xx：服务器错误。',
                                'type' => 'string',
                                'example' => '200',
                            ],
                            'Message' => [
                                'description' => '返回信息。',
                                'type' => 'string',
                                'example' => 'success',
                            ],
                            'RequestId' => [
                                'description' => '公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。',
                                'type' => 'string',
                                'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                200 => [
                    [
                        'errorCode' => 'NotAuthorized',
                        'errorMessage' => 'You are not authorized to call the service. The service has expired, the quota for the subscription is reached, or you have not purchased the service.',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"Code\\": \\"200\\",\\n  \\"Message\\": \\"success\\",\\n  \\"RequestId\\": \\"4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2\\"\\n}","type":"json"}]',
            'title' => '删除样本外部接口',
        ],
        'SendFeedback' => [
            'summary' => '用于风险识别服务的社群样本外部创建。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '79134',
                'abilityTreeNodes' => [
                    'FEATUREsafT73ZWM',
                ],
            ],
            'parameters' => [
                [
                    'name' => 'SampleType',
                    'in' => 'query',
                    'schema' => [
                        'description' => '样本类型。手机号类型样本需传入PHONE，邮箱类型样本需传入EMAIL，账户类型样本需传入ACCOUNT',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => 'PHONE',
                    ],
                ],
                [
                    'name' => 'RiskLabel',
                    'in' => 'query',
                    'schema' => [
                        'description' => '样本标签。用户自定义，以逗号分隔。',
                        'type' => 'string',
                        'required' => false,
                        'docRequired' => true,
                        'example' => 'OTHERS',
                    ],
                ],
                [
                    'name' => 'Value',
                    'in' => 'query',
                    'schema' => [
                        'description' => '样本值。',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => false,
                        'example' => '10000000000',
                    ],
                ],
                [
                    'name' => 'Reason',
                    'in' => 'query',
                    'schema' => [
                        'description' => '风险原因。',
                        'type' => 'string',
                        'required' => false,
                        'docRequired' => false,
                        'example' => 'Abnormal transaction behavior.',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'Code' => [
                                'description' => '接口状态或POP错误码。取值说明如下：2xx：成功。3xx：重定向。4xx：请求错误。5xx：服务器错误。',
                                'type' => 'integer',
                                'format' => 'int32',
                                'example' => '200',
                            ],
                            'Message' => [
                                'description' => '返回信息。',
                                'type' => 'string',
                                'example' => 'success',
                            ],
                            'RequestId' => [
                                'description' => '公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。',
                                'type' => 'string',
                                'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2',
                            ],
                        ],
                    ],
                ],
            ],
            'errorCodes' => [
                200 => [
                    [
                        'errorCode' => 'NotAuthorized',
                        'errorMessage' => 'You are not authorized to call the service. The service has expired, the quota for the subscription is reached, or you have not purchased the service.',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"Code\\": 200,\\n  \\"Message\\": \\"success\\",\\n  \\"RequestId\\": \\"4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2\\"\\n}","type":"json"}]',
            'title' => '创建样本外部接口',
        ],
        'UploadSampleApi' => [
            'summary' => '用于风险识别服务的样本上传。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'readAndWrite',
            'systemTags' => [
                'operationType' => 'create',
                'abilityTreeCode' => '207197',
                'abilityTreeNodes' => [
                    'FEATUREsafT73ZWM',
                ],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'SampleType',
                    'in' => 'query',
                    'schema' => [
                        'description' => '样本的类型'."\n"
                            ."\n"
                            .'- 黑名单: block'."\n"
                            ."\n"
                            .'- 白名单: pass',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'block',
                    ],
                ],
                [
                    'name' => 'DataType',
                    'in' => 'query',
                    'schema' => [
                        'description' => '样本的数据类型'."\n"
                            ."\n"
                            .'- 手机号: mobile'."\n"
                            .'- 手机号MD5: mobileMd5'."\n"
                            .'- IP: ip'."\n"
                            .'- 设备唯一id: umid'."\n"
                            .'- 账号: accountId'."\n"
                            .'- imei: imei'."\n"
                            .'- imeiMd5: imeiMd5'."\n"
                            .'- oaid: oaid'."\n"
                            .'- oaidMd5: oaidMd5'."\n"
                            .'- androidId: androidId'."\n"
                            .'- androidIdMd5: androidIdMd5',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'ip',
                    ],
                ],
                [
                    'name' => 'Service',
                    'in' => 'query',
                    'schema' => [
                        'description' => '生效服务的列表,多个服务用逗号分开'."\n"
                            ."\n"
                            .'- 注册风险识别基础版/增强版: account_abuse'."\n"
                            .'- 营销风险识别基础版/增强版: coupon_abuse'."\n"
                            .'- 登录风险识别基础版/增强版: account_takeover',
                        'type' => 'string',
                        'required' => true,
                        'example' => 'account_abuse,coupon_abuse,account_takeover',
                    ],
                ],
                [
                    'name' => 'DataValue',
                    'in' => 'query',
                    'schema' => [
                        'description' => '样本的具体值，以JSON格式传入。一次不要超过1000条。',
                        'type' => 'string',
                        'required' => true,
                        'example' => '["123.124.125.126","123.124.125.127"]',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'description' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => [
                                'title' => 'Id of the request',
                                'description' => 'Id of the request',
                                'type' => 'string',
                                'example' => '4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2',
                            ],
                            'Message' => [
                                'description' => '返回的错误消息',
                                'type' => 'string',
                                'example' => 'null',
                            ],
                            'Code' => [
                                'description' => '返回的请求码',
                                'type' => 'string',
                                'example' => '200',
                            ],
                            'Success' => [
                                'description' => '访问是否成功的标志',
                                'type' => 'string',
                                'example' => 'true',
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"4A91D2D1-AEC9-1658-ABCE-5A39DE66A5C2\\",\\n  \\"Message\\": \\"null\\",\\n  \\"Code\\": \\"200\\",\\n  \\"Success\\": \\"true\\"\\n}","type":"json"}]',
            'title' => '上传样本接口',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'safconsole.cn-shanghai.aliyuncs.com',
        ],
        [
            'regionId' => 'cn-hangzhou',
            'endpoint' => 'safconsole.cn-hangzhou.aliyuncs.com',
        ],
    ],
];