data/zh_cn/captcha/2023-03-05/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

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'captcha',
        'version' => '2023-03-05',
    ],
    'directories' => [
        'VerifyIntelligentCaptcha',
        [
            'id' => 198934,
            'title' => '下线中',
            'type' => 'directory',
            'children' => [
                'VerifyCaptcha',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'VerifyIntelligentCaptcha' => [
            'summary' => '验证码智能验证接口。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'riskType' => 'none',
                'chargeType' => 'paid',
                'abilityTreeCode' => '194420',
                'abilityTreeNodes' => [
                    'FEATUREwafACFB6T',
                ],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'CaptchaVerifyParam',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '由端上传入的验证参数。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'dsjidsjidsjkds*djsjdiskds'."\n",
                    ],
                ],
                [
                    'name' => 'SceneId',
                    'in' => 'formData',
                    'schema' => [
                        'description' => '场景id。',
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
            ],
            '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' => '95784F***D39FDC5'."\n",
                            ],
                            'Success' => [
                                'description' => '请求是否成功',
                                'type' => 'boolean',
                                'example' => 'true',
                            ],
                            'Code' => [
                                'description' => '响应码',
                                'type' => 'string',
                                'example' => 'Success',
                            ],
                            'Message' => [
                                'description' => '响应消息，若成功请求为success',
                                'type' => 'string',
                                'example' => 'success',
                            ],
                            'Result' => [
                                'description' => '返回结果',
                                'type' => 'object',
                                'properties' => [
                                    'VerifyResult' => [
                                        'description' => '验证结果'."\n"
                                            ."\n"
                                            .'-  true：验证通过'."\n"
                                            ."\n"
                                            .'- false：验证不通过',
                                        'type' => 'boolean',
                                        'example' => 'true',
                                    ],
                                    'VerifyCode' => [
                                        'type' => 'string',
                                    ],
                                    'CertifyId' => [
                                        'description' => '认证ID',
                                        'type' => 'string',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"95784F***D39FDC5\\\\n\\",\\n  \\"Success\\": true,\\n  \\"Code\\": \\"Success\\",\\n  \\"Message\\": \\"success\\",\\n  \\"Result\\": {\\n    \\"VerifyResult\\": true,\\n    \\"VerifyCode\\": \\"\\",\\n    \\"CertifyId\\": \\"\\"\\n  }\\n}","type":"json"}]',
            'title' => '验证码智能验证',
        ],
        'VerifyCaptcha' => [
            'summary' => '验证码验证接口。该接口已不建议接入，请使用VerifyIntelligentCaptcha。',
            'methods' => [
                'post',
                'get',
            ],
            'schemes' => [
                'http',
                'https',
            ],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'create',
                'abilityTreeCode' => '175427',
                'abilityTreeNodes' => [
                    'FEATUREwafACFB6T',
                ],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'CaptchaVerifyParam',
                    'in' => 'query',
                    'schema' => [
                        'description' => '由端上传入的验证参数。',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'dsjidsjidsjkds*djsjdiskds',
                    ],
                ],
            ],
            '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' => '95784F***D39FDC5',
                            ],
                            'Success' => [
                                'description' => '请求是否成功。',
                                'type' => 'boolean',
                                'example' => 'true',
                            ],
                            'Code' => [
                                'description' => '响应码',
                                'type' => 'string',
                                'example' => 'Success',
                            ],
                            'Message' => [
                                'description' => '响应消息，若成功请求为success',
                                'type' => 'string',
                                'example' => 'success',
                            ],
                            'Result' => [
                                'description' => '返回结果',
                                'type' => 'object',
                                'properties' => [
                                    'VerifyResult' => [
                                        'description' => '验证结果。'."\n"
                                            ."\n"
                                            .'- true：验证通过。'."\n"
                                            ."\n"
                                            .'- false：验证不通过。',
                                        'type' => 'boolean',
                                        'example' => 'true',
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'staticInfo' => [
                'returnType' => 'synchronous',
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"95784F***D39FDC5\\",\\n  \\"Success\\": true,\\n  \\"Code\\": \\"Success\\",\\n  \\"Message\\": \\"success\\",\\n  \\"Result\\": {\\n    \\"VerifyResult\\": true\\n  }\\n}","type":"json"}]',
            'title' => '验证码验证',
        ],
    ],
    'endpoints' => [
        [
            'regionId' => 'cn-shanghai',
            'endpoint' => 'captcha.cn-shanghai.aliyuncs.com',
        ],
    ],
];