跳转至

接口列表

此页面中涉及到的所有接口均处于领航测试阶段.

在领航测试阶段,接口的授权方式单独控制,与其他正式释放的API授权方式不同.即:前面几个页面提到的API授权方式无法调用此页面下的接口.获取API授权请通过邮件联系cn-mo-digital@abb.com

接口内容

1 注册设备接口 用于向API中注册设备，以使用后续接口。
2 基础信息查询接口 通过传动序列号获取传动的完整型号、图片、生产日期、发货日期、手册、备件清单。
3 告警/故障代码查询接口 通过传动型号和告警/故障代码获取故障的描述、原因和解决方案。

调用流程

自助生成Client_id和Client_Secret

请参考文档 先决条件，在网页上自行生成Client_id和Client_Secret

获取Token

您可以使用Postman导入以快速使用 接口Collection

URL

https://login.chinacloudapi.cn//oauth2/v2.0/token

请求参数

Route

type var name description
string tenant 与下面body中的tenant值相同

Body: 

{       
    "tenant":"387c56a8-cf86-45de-b9f5-b4de88cac054",  //固定值
    "grant_type":"client_credentials", //固定值
    "scope":"a9fba97d-a28f-46f6-9e86-72befe91fb37/.default",    //固定值
    "client_id":,  //开通授权后，网页显示的API key
    "client_secret":, //开通授权后，网页中生成的 Secret key

}

响应参数

{
    "token_type": "Bearer",   
    "expires_in": 3599,             //token过期时间：1小时
    "ext_expires_in": 3599,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Il9DSkFPdHlzWVZtNXhjMVlvSzBvUTdxeUJDUSJ9.eyJhdWQiOiJhOWZiYTk3ZC1hMjhmLTQ2ZjYtOWU4Ni03MmJlZmU5MWZiMzciLCJpc3MiOiJodHRwczovL2xvZ2luLnBhcnRuZXIubWljcm9zb2Z0b25saW5lLmNuLzM4N2M1NmE4LWNmODYtNDVkZS1iOWY1LWI0ZGU4OGNhYzA1NC92Mi4wIiwiaWF0IjoxNjUxOTIxOTExLCJuYmYiOjE2NTE5MjE5MTEsImV4cCI6MTY1MTkyNTgxMSwiYWlvIjoiNDJKZ1lDaTU4blgyMHBNTzB0T0M3aCt3YUdyNkR3QT0iLCJhenAiOiIyYTZiNTQxNi02NTkyLTQ5NzUtYTY3Yy1lMmFjMjc5YjYzNjYiLCJhenBhY3IiOiIxIiwib2lkIjoiMTA5ZjJkZTEtOTg2Zi00MTkwLTllYTUtNWU3N2M4YWE2MGEwIiwicmgiOiIwLkFBQUFxRlo4T0liUDNrVzU5YlRlaU1yQVZIMnAtNm1Qb3ZaR25vWnl2djZSLXpjRUFBQS4iLCJzdWIiOiIxMDlmMmRlMS05ODZmLTQxOTAtOWVhNS01ZTc3YzhhYTYwYTAiLCJ0aWQiOiIzODdjNTZhOC1jZjg2LTQ1ZGUtYjlmNS1iNGRlODhjYWMwNTQiLCJ1dGkiOiJIanVhcnNOOVhVR3Z5bWxOYWRkWkFRIiwidmVyIjoiMi4wIn0.WbQFOs6XFf6D2JOviVgvubanZy3FVUBgRxd7gRgkhRDoAv0joXImNoOOv7IlZgvwRqEWC6BEXW6Lb3TifO0UjrfLRgqdc42lBQ6L3oc2VBojmd2_w9kRqQspXBe_KYxYrmEUIe6sYXaq02OrQQ5gJiy2LWsMxMHLzEXQiIVEt1WsEeJuA0FgNHdHDyI1gDqyw_bnx_Mfd6lW15t5q3g9J0RzPA8C5cWn5ludiNVQl0CqeTKpcr5K3eNZJCeJaZhPR5xhYmQyCpgxUR4NvQkPgg9S0N2BGzcf1jw-Ay6sQ4ImMJSOpnHaHyWAMDiHOfVskZhyv5OSOu-4QHf2T3jNDg"
}

接口详情

基础地址

Base_URL:

https://open.digital.motion.abb.com.cn

请求头

所有的接口请求头中需包含：

"Authorization": Bearer

统一返回格式

接口的返回都会遵循以下结构： 

{
    "isSuccess": true,
    "data":{},
    "errorCode": "string",
    "errorMessage": "string"
}

  • 如果请求成功，则返回结果会包含

    object Data

  • 如果请求失败，则返回结果会包含

    string ErrorCode string ErrorMessage

设备注册

URL

POST {Base_URL}/common/commonapi/v1/device/register/{sn}

请求参数

Route:

type var name description
string sn 设备序列号

Body: 

{
    "productModelName":"string",      //
    "propertyFlag": "string",         //非必选项，设备标记或Id
    "manufacturer": "string",         //非必选项，制造商
    "subscriptionLevel": "string",    //非必选项，订阅等级
}

响应参数

统一输出

特殊说明

当前此接口接受所有传动序列号的注册。未来可能会仅开放给Motion365设备之外

基础信息查询

请注意：此接口中目前仅支持ACS355/ACS380/ACS510/ACS530/ACS550/ACS580/ACS800/ACS880和ACH531/ACQ531以及ACH580/ACQ580等产品型号。

URL

GET {Base_URL}/common/commonapi/v1/device/{sn}/info

请求参数

Route:

type var name description
string sn 设备序列号

响应参数

{
    "isSuccess": true,
    "data": {
        "id": "Guid",
        "img": "byte[]",     //产品图片
        "propertyFlag": "string",
        "sn": "string",      //产品序列号
        "manufacturer": "string",      
        "subscriptionLevel": "string",  
        "shortTypeCode": "string",  //产品型号
        "longTypeCode": "string",   //产品完整型号
        "frameSize": "string",      //产品结构代码
        "manufacturingDate": "date",  //生产日期
        "deliveryDate": "date",   //发货日期
        "commissionDate": "date",  //调试日期。只有在DIB中注册过传动才有此信息
        "manual":[{
            "name": "string",   //产品手册名称
            "url": "string"         //产品手册下载地址
        }],
        "spareParts":[{
            "name": "string",   //备件产品名称
            "kinds": "string",  //备件产品
            "type": "string",   //备件型号
            "code": "string",   //备件物料号
            "softwareType": "string", //如果备件是ZMU，此处会显示固件版本信息，如ACS880 Primary Control program
            "availableCode": "string", //特殊固件版本，如N2200
            "count": 0
        }]
    }
}

告警/故障代码查询接口

请注意：此接口中目前仅支持ACS355/ACS380/ACS510/ACS530/ACS550/ACS580/ACS800/ACS880和ACH531/ACQ531以及ACH580/ACQ580等产品型号。

URL

GET {Base_URL}/common/commonapi/v1/error-info/sn/{sn}/code/{code}

请求参数

Route:

type var name description
string sn 设备序列号
string code 错误代码

Query:

type var name description
string firmware 非必填项，固件名称（匹配最接近的） e.g:INFT, INFTAND -> INFT

响应参数

{
    "code": "string",      //告警、故障代码
    "errorType": "string",
    "reason": "string",    //告警、故障原因
    "solution": "string"   //告警、故障解决方案
}

Back to top