summaryrefslogtreecommitdiff
path: root/data/en_us/facebody/2020-09-10/api-docs.php
blob: 2f330f17b333a6792dafee9e590599e3d8c3c1f6 (plain)
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
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'facebody', 'version' => '2020-09-10'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['ExecuteServerSideVerification'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'ExecuteServerSideVerification' => [
            'summary' => '核身纯服务端版',
            'path' => '/viapi/thirdparty/realperson/execServerSideVerification',
            'methods' => ['post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/x-www-form-urlencoded'],
            'produces' => ['application/json'],
            'operationType' => 'readAndWrite',
            'deprecated' => false,
            'systemTags' => [],
            'parameters' => [
                [
                    'name' => 'certificateName',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'example' => '', 'required' => false, 'type' => 'string'],
                ],
                [
                    'name' => 'certificateNumber',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'example' => '1281739873298172981', 'required' => false, 'type' => 'string'],
                ],
                [
                    'name' => 'facialPictureData',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'example' => '/9j/wwew...', 'format' => 'byte', 'required' => false, 'type' => 'string'],
                ],
                [
                    'name' => 'facialPictureUrl',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'example' => 'http://xxx.xxx.com/xxx.jpg', 'required' => false, 'type' => 'string'],
                ],
                [
                    'name' => 'sceneType',
                    'in' => 'formData',
                    'schema' => ['description' => '', 'example' => 'server', 'required' => false, 'type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '',
                        'properties' => [
                            'RequestId' => ['description' => '', 'example' => 'CE2FFC8A-6669-4F02-B4DA-95888087FBDC', 'title' => 'Id of the request', 'type' => 'string'],
                            'Data' => [
                                'description' => '',
                                'properties' => [
                                    'Pass' => ['description' => '', 'example' => 'true', 'type' => 'boolean'],
                                    'VerificationToken' => ['description' => '', 'example' => '6f1f730e732b232ccbdd85abc751****', 'type' => 'string'],
                                    'Reason' => ['description' => '', 'example' => '', 'type' => 'string'],
                                ],
                                'type' => 'object',
                            ],
                        ],
                        'title' => 'Schema of Response',
                        'type' => 'object',
                    ],
                ],
            ],
            'staticInfo' => [],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"CE2FFC8A-6669-4F02-B4DA-95888087FBDC\\",\\n  \\"Data\\": {\\n    \\"Pass\\": true,\\n    \\"VerificationToken\\": \\"6f1f730e732b232ccbdd85abc751****\\",\\n    \\"Reason\\": \\"认证通过(Z8120)\\"\\n  }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>CE2FFC8A-6669-4F02-B4DA-95888087FBDC</RequestId>\\n<Data>\\n    <Pass>true</Pass>\\n    <VerificationToken>6f1f730e732b232ccbdd85abc751****</VerificationToken>\\n    <Reason>认证通过(Z8120)</Reason>\\n</Data>","errorExample":""}]',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-shanghai', 'endpoint' => 'facebody.cn-shanghai.aliyuncs.com'],
    ],
];