响应结果

在接受到API请求后，星纵物联开放平台会根据HTTP状态码的形式进行回应，该状态码表示请求的结果，并携带一个JSON响应体，其中包含API调用的请求信息。

成功响应示例

说明

对于响应成功的请求，星纵物联开放平台会返回HTTP200状态码，以及一个响应体，其中包含API调用所请求的信息，如下表所示：

参数 类型 描述
data Object API调用请求的详细信息
status String 请求结果

在成功的响应中，结果是Success。
requestId String 请求的唯一ID，可用于快速定位请求。
示例

以下示例展示了一个成功的响应获取访问Token。

HTTP/1.1 200 OK
{
    "data": {
        "access_token": "eyJhbGciOiJSUzI1iIsR5xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "refresh_token": "eyJhbGciOiJSUz1N8l6bHEtXNxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "expires_in": 3599
        "refresh_token_expires_in": 2591999
    },
    "status": "Success",
    "requestId": "72fea33ad6f721a3a218cc6f60c5fff1"
}

错误响应示例

说明

对于不成功的请求，星纵物联开放平台会返回HTTP 4xx or 500 状态码，以及详细的错误消息，帮助你快速解决错误并修改请求。

参数 类型 描述
status String 请求结果

错误响应中的结果是 Failed。
requestId String 请求的唯一ID，可用于快速定位请求。
errCode String 错误原因
errMsg String 关于错误详细和具体信息
示例

以下示例展示了请求使用无效授权时，根据获取访问令牌的错误响应：

HTTP/1.1 401 Unauthorized
{
    "status": "Failed",
    "requestId": "7bc8257ddaac3e87321f11221960d0f9",
    "errCode": "authentication_failed",
    "errMsg": "Bad credentials"
}