Skip to content

配置API服务 (POST)

更新时间:

该接口用于配置API服务,实现物平台的服务调用能力。通常还需要配置页面集成,需要自己配置appid/secureKey。

配置API服务后,系统将自动创建对应的“第三方应用”用户。用户的账号/密码分别对应appid/secureKey。

第三方用户可调用的API服务在其应用管理卡片的”其他 > 赋权“页面,进行自定义配置。

请求接口

POST /api/application

TIP

访问权限:需要登录超级设备管理平台获取token,并校验token

请求参数

名称位置类型必选说明
X-Access-Tokenheaderstringtrue平台token
bodybodyobjecttrue-
» idbodystringtrueID
» namebodystringtrue名称
» descriptionbodystringfalse说明
» namebodystringtrue名称
» providerbodystringtrue应用类型
» integrationModesbodyarraytrue接入方式,填入apiServer
» apiServerbodyobjecttrue-
»» appIdbodystringtrueApp ID,自定义
»» secureKeybodystringtrue密钥Key
»» roleIdListbodyarraytrue角色
调用角色列表接口,获取角色ID,赋予API服务相应角色。
»» orgIdListbodyarrayfalse组织
调用组织列表接口,获取组织ID,赋予API服务相应组织。
»» redirectUribodystringfalse回调地址

响应参数

以200 Response为例,响应参数如下:

名称类型必选约束说明
» messagestringtruenone消息提示
» resultobjecttruenone数据内容
»» idst ringtruenoneID
»» namestringtruenone用户名
»» providerstringtruenone接入方式
»» descriptionstringtruenone说明
»» integrationModes[object]truenone集成模式
»»» textstringtruenone集成模式名称
»»» valuestringtruenone集成模式标识
»» apiServerobjecttruenone-
»»» secureKeyobjecttruenone密钥Key
»»» signaturestringtruenone签名
»»» roleIdListarraytruenone角色
»»» orgIdListarraytruenone组织
»» stateobjecttruenone状态
»»» textstringtruenone状态名称
»»» valuestringtruenone状态标识
»» creatorIdstringtruenone创建者ID
»» createTimeintegertruenone创建时间
» statusintegertruenone响应状态码
» timestampintegertruenone时间戳

响应状态码

状态码状态码含义说明
200OK成功
401Unauthorized登录状态已过期,token不能为空
500Internal Server Error服务器内部异常

Body示例

json
{
  "provider":"internal-standalone",
  "integrationModes":["apiServer"],
  "apiServer":{
    "appId":"ykjCyWAG5MDnTmFY",
    "secureKey":"BkPZhjK36Zb8M2KRpKdAM2krCDCNNdYZ",
    "roleIdList":["1589807922792402944"],
    "orgIdList":["1595617360684232704"]
  },
  "name":"API服务-测试",
  "description":"1",
  "id":"ykjCyWAG5MDnTmFY"
}
{
  "provider":"internal-standalone",
  "integrationModes":["apiServer"],
  "apiServer":{
    "appId":"ykjCyWAG5MDnTmFY",
    "secureKey":"BkPZhjK36Zb8M2KRpKdAM2krCDCNNdYZ",
    "roleIdList":["1589807922792402944"],
    "orgIdList":["1595617360684232704"]
  },
  "name":"API服务-测试",
  "description":"1",
  "id":"ykjCyWAG5MDnTmFY"
}

返回示例

json
{
    "message": "success",
    "result": {
        "id": "ykjCyWAG5MDnTmFY",
        "provider": "internal-standalone",
        "name": "API服务-测试",
        "description": "1",
        "integrationModes": [
            {
                "text": "API服务",
                "value": "apiServer"
            }
        ],
        "apiServer": {
            "secureKey": "BkPZhjK36Zb8M2KRpKdAM2krCDCNNdYZ",
            "signature": "MD5",
            "roleIdList": [
                "1589807922792402944"
            ],
            "orgIdList": [
                "1595617360684232704"
            ]
        },
        "state": {
            "text": "启用",
            "value": "enabled"
        },
        "creatorId": "1199596756811550720",
        "createTime": 1693451400166
    },
    "status": 200,
    "timestamp": 1693451400517
}
{
    "message": "success",
    "result": {
        "id": "ykjCyWAG5MDnTmFY",
        "provider": "internal-standalone",
        "name": "API服务-测试",
        "description": "1",
        "integrationModes": [
            {
                "text": "API服务",
                "value": "apiServer"
            }
        ],
        "apiServer": {
            "secureKey": "BkPZhjK36Zb8M2KRpKdAM2krCDCNNdYZ",
            "signature": "MD5",
            "roleIdList": [
                "1589807922792402944"
            ],
            "orgIdList": [
                "1595617360684232704"
            ]
        },
        "state": {
            "text": "启用",
            "value": "enabled"
        },
        "creatorId": "1199596756811550720",
        "createTime": 1693451400166
    },
    "status": 200,
    "timestamp": 1693451400517
}