Loading...

    一、单终端启用

    功能说明

    按终端序列号或终端号启用终端

    实现方法

    REST URL

    POST https://sdk.xylink.com/api/rest/external/v1jix/terminal/enable?enterpriseId=XXX&signature=XXX&queryType=XXX¶m=XXX

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云

    queryType

    String

    Query

    sn

    查询类型,取值为 sn 或 number

    5.2-20260928

    公有云

    param

    String

    Query

    终端序列号或当前终端号

    5.2-20260928

    公有云

    示例代码

    结果示例

    请求成功返回结果示例

    {
    "sn": "2D15100905B343XX",
    "deviceNumber": "123456",
    "enabled": true
    }

    返回参数说明:

    参数

    说明

    sn

    sn

    deviceNumber

    终端号

    enabled

    成功时固定为 true;重复启用同样按幂等成功返回


    二、单终端停用

    功能说明

    按终端序列号或终端号停用终端

    实现方法

    REST URL

    POST https://sdk.xylink.com/api/rest/external/{version}/terminal/disable

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云

    queryType

    String

    Query

    sn

    查询类型,取值为 sn 或 number

    5.2-20260928

    公有云

    param

    String

    Query

    终端序列号或当前终端号

    5.2-20260928

    公有云

    示例代码

    结果示例

    请求成功返回结果示例

    {
    "sn": "2D15100905B343XX",
    "deviceNumber": "123456",
    "enabled": false
    }

    返回参数说明:

    参数

    说明

    sn

    sn

    deviceNumber

    终端号

    enabled

    成功时固定为 true;重复启用同样按幂等成功返回



    三、终端批量启用

    功能说明

    按终端序列号或终端号启用终端

    实现方法

    REST URL

    POST /api/rest/external/{version}/terminal/enable/batch

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云

    queryType

    String

    Query

    sn

    查询类型,取值为 sn 或 number

    5.2-20260928

    公有云

    paramList

    List

    Body

    终端序列号或终端号 集合

    5.2-20260928

    公有云

    示例代码

    请求示例

    {
    "paramList":["2D15100905B343XX"]
    }

    结果示例

    请求成功返回结果示例

    [{
    "sn": "2D15100905B343XX",
    "deviceNumber": "123456",
    "enabled":
    }]

    返回参数说明:

    参数

    说明

    sn

    sn

    deviceNumber

    终端号

    enabled

    成功时固定为 true;重复启用同样按幂等成功返回


    四、终端批量停用

    功能说明

    按终端序列号或终端号停用终端

    实现方法

    REST URL

    POST /api/rest/external/{version}/terminal/disable/batch

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云

    queryType

    String

    Query

    sn

    查询类型,取值为 sn 或 number

    5.2-20260928

    公有云

    paramList

    List

    Body

    终端序列号或终端号 集合

    5.2-20260928

    公有云

    示例代码

    请求示例

    {
    "paramList":["2D15100905B343XX"]
    }

    结果示例

    请求成功返回结果示例

    [{
    "sn": "2D15100905B343XX",
    "deviceNumber": "123456",
    "enabled": false
    }]

    返回参数说明:

    参数

    说明

    sn

    sn

    deviceNumber

    终端号

    enabled

    成功时固定为 false;重复启用同样按幂等成功返回


    五、单终端启用状态查询

    功能说明

    按终端序列号或终端号查询终端状态

    实现方法

    REST URL

    GET https://sdk.xylink.com/api/rest/external/v1/terminal/status

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云

    queryType

    String

    Query

    sn

    查询类型,取值为 sn 或 number

    5.2-20260928

    公有云

    param

    String

    Query

    终端序列号或当前终端号

    5.2-20260928

    公有云

    示例代码

    结果示例

    请求成功返回结果示例

    {
    "sn": "2D15100905B343XX",
    "deviceNumber": "123456",
    "enabled": false
    }

    返回参数说明:

    参数

    说明

    sn

    sn

    deviceNumber

    终端号

    enabled

    启用为 true;停用为 false


    六、终端批量状态查询

    功能说明

    按终端序列号或终端号查询终端状态

    实现方法

    REST URL

    GET https://sdk.xylink.com/api/rest/external/v1/terminal/status/batch

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云

    queryType

    String

    Query

    sn

    查询类型,取值为 sn 或 number

    5.2-20260928

    公有云

    paramList

    List

    Body

    终端序列号或终端号 集合

    5.2-20260928

    公有云

    示例代码

    请求示例

    {
    "paramList":["2D15100905B343XX"]
    }

    结果示例

    请求成功返回结果示例

    [{
    "sn": "2D15100905B343XX",
    "deviceNumber": "123456",
    "enabled": false
    }]

    返回参数说明:

    参数

    说明

    sn

    sn

    deviceNumber

    终端号

    enabled

    启用为 true;停用为 false