diff options
Diffstat (limited to 'data/zh_cn/captcha/2023-03-05')
| -rw-r--r-- | data/zh_cn/captcha/2023-03-05/api-docs.php | 228 |
1 files changed, 228 insertions, 0 deletions
diff --git a/data/zh_cn/captcha/2023-03-05/api-docs.php b/data/zh_cn/captcha/2023-03-05/api-docs.php new file mode 100644 index 0000000..de7654b --- /dev/null +++ b/data/zh_cn/captcha/2023-03-05/api-docs.php @@ -0,0 +1,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', + ], + ], +]; |