6.1 API概览

对 HSR API 接口调用是通过向 HSR API 的服务端地址发送 HTTP[S] POST 或 GET 请求，并按照接口说明在请求中加入相应请求参数来完成的；根据请求的处理情况，系统会返回处理结果。

6.1.1 本页面列出了 HSR 所有 API 接口

6.1.2 请求结构

服务地址

API 的服务接入地址为：api.robotscloud.com

请求地址

支持通过 HTTP， HTTPS 通道进行请求通信

请求方法

支持 HTTP GET， POST 方法

字符编码

请求及返回结果都使用 UTF-8 字符集进行编码

6.1.3 公共参数

暂无

6.1.4 返回结果

JSON结构

成功结果

{
    "ret": 0,
    "msg": "ok",
    "face_id": "dfasdfklasdjgasdkjoiwefajsdlfkasdfasdfasdfasdfasdf"
}

错误结果

{
    "ret": 1,
    "msg": "error"
}

调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码以及下述 公共错误码 来定位错误原因。