2. 登录接口

功能描述

    通过http协议或者https协议向远程云平台请求登录,获取token, MQ服务器连接参数配置。具体是走http协议,还是走https协议,由用户在配置SE3 AI迷你机时指定的管理平台URL前缘决定。

请求地址

   通过SE3 AI 迷你机上的界面进行登录URL的填写。

请求参数

参数类型默认值选择描述举例

dev_sno

string

必选

授权码,通过SE3 AI 迷你机配置界面上进行配置,在请求URL时携带

hex_mac

string

必选

16进制mac地址字符串,上传到管理平台,告知管理平台dev_sno授权码被SE3 AI 迷你机占用

“0xe0a50900062b”,其中0x为16进制标志,后面为mac地址

示例:
http://ip:port/login?dev_sno=xxxx&hex_mac=0xe0a50900062b

管理平台返回值:

请求成功:

一级参数

二级参数

类型

选择

描述

token

string

必选

请求云平台接口需要携带的参数

imgServerAddr

string

可选

图片服务器URL,用于获取用户照片。如果下发得图片中是相对路径,则需要填写此地址。

recordAddr

string

可选

管理平台URL列表,每个URL(可以为绝对地址,也可以相对地址)间以逗号分隔。 用于接收“人员通行记录”。 如: 示例1:"/getRecord , /getRecord2", 示例2:"/getRecord , https://xxxx.com/getBackupRecord" 示例3:"http://xxx.com/getRecord, http://xxx.com/getBackupRecord"

record UploadPeriod

int

可选

通行记录周期上传时间,大于等于1秒,默认值为5秒

recordUploadReg

int

可选

通行记录中选择是否上传人脸注册底库图,默认为上传,值为1

recordUploadSpotPic

int

可选

通行记录中选择是否上传背景图,默认为上传,值为1

recordUploadRecognizeFace

int

可选

通行记录中选择是否上传背景图中当前的人脸图,默认上传,值为1

device ListInfoAddr

string

可选

管理平台URL(相对地址),用于接收“设备添加事件”。如:/deviceListInfoAddr

device MonitorAddr

string

可选

管理平台URL (相对地址) , 用于设置设备状态上报得周期,默认20秒

device MonitorPeriod

int

可选

管理平台URL (相对地址) , 用于设置设备状态上报得周期,默认20秒

rabbitmq

dict

必选

MQ服务器配置参数集合

host

string

必选

MQ服务器地址, 如 mq.xxx.com

port

int

必选

MQ服务器连接端口

login

string

必选

MQ服务器登录用户名

password

string

必选

MQ服务器连接密码

queue

string

必选

MQ消息下发队列

vHost

string

可选

MQ服务器登录用户名及下发队列所在虚拟主机.如果不指定,默认为"/"。

uploadVHost

string

可选

MQ服务器上报队列所在虚拟主机。如果不指定,默认为"/"。

uploadQueue

string

可选

MQ消息上传队列, 可以选择不通过MQ消息队列回传结果, 在uploadVHost虚拟主机下。默认是不支持MQ消息上传(即单向通信)。

fiqa DownQueue

string

可选

人脸图片质量检测(FIQA)命令下发队列。 注意:当把SE3 AI迷你机用作图片质量校验服务器时,需要下发此栏位。否则不支持通过MQ命令进行FIQA校验功能。

fiqa UploadQueue

string

可选

人脸图片质量检测(FIQA)命令结果上传队列。 注意:当把SE3 AI迷你机用作图片质量校验服务器时,需要下发此栏位。否则不支持通过MQ命令进行FIQA校验功能。

unNeed BindExchange

bool

可选

消息队列是否需要绑定到交换机, 默认为false, 即需要绑定到消息队列。

exchange

dict

必选

请参考下面exchange字段

exchange字段信息如下:

二级参数

三级参数

exchange

name

string

必选

交换机名称

type

string

必选

交换机类型

passive

bool

必选

检查交换机是否存在,默认为false

durable

bool

必选

队列持久化标志,true为持久化队列

auto_ delete

bool

必选

自动删除

arguments

dict

可选

其他交换机配置参数,默认不需要传,值为null

示例:

{
    "deviceListInfoAddr": "/box/device/sync", 
    "recordAddr": "/box/cross/record/report", 
    "recordUploadPeriod": 5, 
    "recordUploadReg":1,
    "recordUploadSpotPic":1,
    "recordUploadRecognizeFace":1,
    "deviceMonitorAddr": "/box/monitor/status/report", 
    "deviceMonitorPeriod": 20,
    "message": "登录成功", 
    "imgServerAddr": "", 
    "rabbitmq": {
        "exchange": {
            "durable": true,
            "arguments": null, 
            "name": "exchange-dev-UMOTRU000120190909103019", 
            "passive": false, 
            "type": "topic", 
            "auto_delete": false,
            "routingKey": "routing.dev.UMOTRU000120190909103019"
         }, 
        "password": "13R9U9", 
        "port": 5672, 
        "vHost": "/UMOTRU000120190909103019", 
        "fiqaUploadQueue": "topic.fiqa.upload", 
        "uploadQueue": "upload-queue", 
        "uploadVHost": "/upload", 
        "queue": "queue-dev-UMOTRU000120190909103019", 
        "login": "UMOTRU000120190909103019", 
        "fiqaDownQueue": "topic.fiqa.download", 
        "host": "192.168.1.102", 
        "unNeedBindExchange": true, 
        }, 
        "token": "f1556c25c66e4d24afa7b02906b1c8c1" 
}

请求失败:

如果http返回状态码不为 200,则认为本次登录请求失败,建议返回如下:

一级参数

二级参数

类型

描述

error

code

int

请求错误码,如:500001

message

string

错误描述

status

string

错误类型

Last updated