人脸识别应用服务

人脸识别应用服务

API说明

1.请求方式

    请求地址：https://doc.ylyw.vip

    请求方法：get、post、put、delete

2.系统参数

参数名类型
是否必须说明
appidstring是系统分配的应用appid
signstring是参数签名

3.业务参数

    调用API时不仅必须传入系统参数，还需要根据API的具体参数传入业务参数。

4.签名算法说明

    （1）设传递参数为集合M，将集合M内非空参数值的参数名按照ASCII码从小到大排序（字典序），将集合M转成json字符串

    特别注意：

    ❗️参数名ASCII从小到大排序（字典序）

    ❗️如果参数值为空不参与签名

    ❗️参数名区分大小写

    （2）将json字符串进行md5加密，并转大写

    （3）将得到的大写字串作为系统参数sign的值进行传递

    以php为例签名写法：

<?php
    $sign = strtoupper(md5(json_encode($post,JSON_UNESCAPED_UNICODE)));//$post为集合M


错误码

错误码
错误描述解决方案
4001验签失败对签名算法进行检查，是否符合规定要求
4002接收参数不符合要求检查请求参数


添加设备

1.请求URL:

   `https://doc.ylyw.vip/device `

  

2.请求方式：

     POST 


3.请求参数：

参数名
是否必填类型说明
sign是string签名
deviceKey是string设备key
type是string类型（1uface，2魔点）
appid是stringappid
name是string设备名称

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示
deviceKey否string激活成功接口返回的设备key


5.请求示例：

    `http://doc.ylyw.vip/device`

    POST请求

    

    {   

        "name":"测试uface",

        "deviceKey":"84E0F4207F3201F8",

        "type":"1",

        "appid":"fffb81ce37562fc2",

        "sign":"252EC5CD88CA8EC2CA00B78277104324"

    }    


6.返回结果示例：

   {

        "code":1,

        "msg":"添加设备成功",

        "deviceKey":"84E0F4207F3201F8"

    }

解绑设备

1.请求URL:

   `https://doc.ylyw.vip/device `

  

2.请求方式：

     DELETE


3.请求参数：

参数名
是否必填类型说明
sign是string签名
deviceKey是string设备key
type是string类型（1uface，2魔点）
appid是stringappid

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示(删除成功)


5.请求示例：

    `http://doc.ylyw.vip/device`

    DELETE请求

    

    {   

        "deviceKey":"84E0F4207F3201F8",

        "type":"1",

        "appid":"fffb81ce37562fc2",

        "sign":"252EC5CD88CA8EC2CA00B78277104324"

    }    


6.返回结果示例：

   {

        "code":1,

        "msg":"删除设备成功"

    }

添加人员

1.请求URL:

   `https://doc.ylyw.vip/user`

  

2.请求方式：

     POST 


3.请求参数：

参数名
是否必填类型说明
sign是string签名
head_img否string头像url
type是string类型（1uface，2魔点）
appid是stringappid
name是string人员名称

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示
data否string添加成功的返回对应用户guid


5.请求示例：

    `http://doc.ylyw.vip/user`

    POST请求

    

    {       

        "name":"uface2",

        "head_img":"",

        "type":"1",

        "appid":"fffb81ce37562fc2",

        "sign":"7AC75A51FFFA9F2F5CD9D31F3D166CDB"

    }    


6.返回结果示例：

   

    {

        "code": 1,

        "msg": "新增用户成功",

        "data": {

            "uface": "05C947DCB25F42BB9CED23EEF322A537"

        }

    }


删除人员

1.请求URL:

   `https://doc.ylyw.vip/user`

  

2.请求方式：

     DELETE


3.请求参数：

参数名
是否必填类型说明
sign是string签名
guid是string用户guid
type是string类型（1uface，2魔点）
appid是stringappid

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示


5.请求示例：

    `http://doc.ylyw.vip/user`

    DELETE请求 


    {

        "guid":"05C947DCB25F42BB9CED23EEF322A537",

        "type":"1",

        "appid":"fffb81ce37562fc2",

        "sign":"1A684D1CDEC3DB10B3251EFB3DB9DC2E"

    }


6.返回结果示例：   

    {

        "code": 1,

        "msg": "删除人员成功"

    }


更新人员

1.请求URL:

   `https://doc.ylyw.vip/user`

  

2.请求方式：

     PUT


3.请求参数：

参数名
是否必填类型说明
sign是string签名
head_img否string头像url
type是string类型（1uface，2魔点）
appid是stringappid
guid是string用户guid
name否string人员名称

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示


5.请求示例：

    `http://doc.ylyw.vip/user`

    PUT请求

    

    {       

        "guid":"8F69050776AC451EADF02C9E0C757B72",

        "name":"uface2",

        "head_img":"",

        "type":"1",

        "appid":"fffb81ce37562fc2",

        "sign":"7AC75A51FFFA9F2F5CD9D31F3D166CDB"

    }    


6.返回结果示例：

    {

        "code": 1,

        "msg": "更新用户信息成功",

    }


添加权限

1.请求URL:

   `https://doc.ylyw.vip/auth`

  

2.请求方式：

     POST


3.请求参数：

参数名
是否必填类型说明
sign是string签名
guid是string用户guid
type是int类型（1uface，2魔点）
appid是stringappid
deviceKey是string要授权的设备key
is_allday是int0临时权限，1永久权限
start_time是timestamp临时权限的开始时间
end_time是timestamp临时权限的结束时间

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示


5.请求示例：

    `http://doc.ylyw.vip/auth`

    POST请求 


    {

        "deviceKey":"1635580763904671744",

        "guid":"1635925598247321600",

        "type":"2",

        "is_allday":0,

        "start_time":"2019-06-10 17:10:00",

        "end_time":"2019-06-10 17:20:00",

        "sign":"7FFA9F41020FE6A5AEA31A12E4163394",

        "appid":"fffb81ce37562fc2"

    }


6.返回结果示例：   

    {

        "code": 1,

        "msg": "授权成功"

    }


删除权限

1.请求URL:

   `https://doc.ylyw.vip/auth`

  

2.请求方式：

     DELETE


3.请求参数：

参数名
是否必填类型说明
sign是string签名
guid是string用户guid
type是int类型（1uface，2魔点）
appid是stringappid
deviceKey是string要授权的设备key

 

4.返回参数：

参数是否一定存在类型说明
code是int接口返回结果
msg是string接口返回结果提示


5.请求示例：

    `http://doc.ylyw.vip/auth`

    DELETE请求 


    {

        "deviceKey":"1635580763904671744",

        "guid":"1635925598247321600",

        "type":"2",

        "sign":"3A3B188DC5C27FF42FB69F28285D6324",

        "appid":"fffb81ce37562fc2"

    }


6.返回结果示例：   

    {

        "code": 1,

        "msg": "人员销权成功"

    }