服务商授权管理

API 列表

请求方式	API	描述
POST	/v1.0/osaas/contractor/authorization	创建服务商授权
GET	/v1.0/osaas/contractor/authorizations	分页查询服务商授权列表
DELETE	/v1.0/osaas/contractor/authorizations/{authorization_id}	解除服务商授权
GET	/v1.0/osaas/contractors	获取已合作的服务商列表

创建服务商授权

接口描述

调用该接口创建服务商授权

接口地址

POST /v1.0/osaas/contractor/authorization

请求参数

参数名	类型	参数类型	说明	是否必需
country_code	String	BODY	国家码(中国:86)	是
username	String	BODY	服务商账号	是

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	授权唯一标识

请求示例

POST /v1.0/osaas/contractor/authorization

{
  "countryCode": "86",
  "username": "test@tuya.com"
}

响应成功示例

{
  "success": true,
  "t": 1566053034624,
  "result": "1160823965053******"
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询服务商授权列表

接口描述

调用该接口分页查询服务商授权列表

接口地址

GET /v1.0/osaas/contractor/authorizations

请求参数

参数名	类型	参数类型	说明	是否必需
page_no	Integer	URL	页码(page_no>0)(默认1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认20)	否

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
authorizations	Arrays	授权集合

authorizations 参数说明

参数名	类型	说明
authorization_id	String	授权唯一标识
username	String	服务商主账号"
enterprise_name	String	服务商企业名称
cooperation_time	Long	合作时间，13位戳(默认为0，施工商确认授权则赋值)

请求示例

GET {url}/v1.0/osaas/contractor/authorizations?page_no=1&page_size=10

响应成功示例

{
  "total": 1,
  "pageNo": 1,
  "pageSize": 10,
  "authorizations": [
    {
      "authorization_id": "授权唯一标识",
      "username": "服务商主账号",
      "enterprise_name": "服务商企业名称",
      "cooperation_time": 1561378856383,
    }
  ]
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

解除服务商授权

接口描述

调用该接口解除服务商授权

接口地址

DELETE /v1.0/osaas/contractor/authorizations/{authorization_id}

请求参数

参数名	类型	参数类型	说明	是否必需
authorization_id	String	URI	授权唯一标识	是

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

DELETE {url}/v1.0/osaas/contractor/authorizations/1822788*******

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

获取已合作的服务商列表

接口描述

调用该接口获取已合作的服务商列表

接口地址

GET /v1.0/osaas/contractors

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Array	已授权施工商集合

result参数说明

参数名	类型	说明
contractor_uid	String	服务商用户唯一标识
contractor_name	String	服务商名称

响应成功示例

{
  "result": [
    {
      "contractor_uid": "bayxxxxxxxxxxxxxfcDz",
      "contractor_name": "XXX 服务商"
    }
  ],
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误