微信相框

API的文档位于 https://dev.izhiju.cn/api/doc/

该文档可通过Swagger UI获得,极大地帮助测试和探索公开的服务。

为了通过API访问REST资源,需要一个身份验证令牌。幸运的是,可以通过执行身份验证API轻松获取令牌。有几种方法可以调用API,一种简单的方法是使用Swagger UI:

  • 用户名:text 密码:xxxx
  • 二维码 (传入设备参数scene_id参数必须是9位int整数,生成的二维码为临时二维码有效期30天,具体调用操作如下)
  • 用户登录接口请查看:用户接口

1. 调用生成二维码接口

  • 参数:
  • width: 代表二维码的尺寸
  • sceneId: 填写设备id

请求成功: 返回200 是已经生成成功了二维码(api上没有显示二维码图片),401授权失败,500服务器问题

使用工具方法:

  • 调用生成二维码接口

2. 查询设备是否存在接口

  • 参数: * clientId: 填写设备id

请求成功: 返回Json数据

  • 调用生成二维码接口
  • Json数据中 islosk==true 无法绑定

3. 扫码绑定

  • 参数: * ticket: 查询设备是否存在接口返回的json数据中

请求成功: 返回系统Json数据


4. 根据mac地址查询设备是否存在接口

  • 参数: * serialNumber: 序列号 * mac:MAC地址

请求成功: 返回Json数据 调用生成二维码接口


5. DPF修改绑定状态接口

  • 参数: * clientId: 设备id * islock: true或false

请求成功: 返回Json数据 调用生成二维码接口


6. 根据name和设备id查询接口

  • 参数: * clientId: 设备id * nickName: 昵称

请求成功: 返回Json数据 调用生成二维码接口


7. 上传图片接口

使用工具如下: 调用生成二维码接口 请求成功: 返回Json数据 如上图;


8. 查询用户设备列表接口

  • 参数: * scopeId: 登录中获取 * userId: 用户id 或者 unionid * userType: INTERNAL 或者 wechat

请求成功: 返回Json数据 如图;

  • 调用生成二维码接口

9. 添加用户设备接口

  • 参数: * 调用生成二维码接口 * deviceId: 设备id * deviceStatus: 0(固定) * relationship: friend(固定) * unionId: 用户id 或者 unionid * userType: INTERNAL 或者 wechat * 至少传以上这些参数 还可以根据需求加

请求成功: 返回Json数据 如图;

  • 调用生成二维码接口

10. 用户查询设备接口

  • 参数:

    * scopeId:  登录获取
    * deviceId: 设备id
    * userId:  用户id 或者 unionid
    * userType:  INTERNAL 或者 wechat 
    

请求成功: 返回Json数据 如图;

  • 调用生成二维码接口

11. 删除用户设备接口

  • 参数:

    * scopeId:  登录获取
    * deviceId: 设备id
    * userId:  用户id 或者 unionid
    * userType:  INTERNAL 或者 wechat 
    

请求成功: 返回code:200


12. 重置设备ID指定的设备接口

  • 参数: * scopeId: 登录获取 * deviceId: 设备id

请求成功: 返回code:200


13. 根据deviceId查询列表

  • 参数: * scopeId: 登录获取 * deviceId: 设备id

请求成功: 返回deviceId下绑定的所有用户列表


14. 根据deviceId查询用户名列表

  • 参数: * scopeId: 登录获取 * deviceId: 设备id

请求成功: 返回deviceId下绑定的所有用户名列表


15. 根据unionId查询用户

  • 参数: * scopeId: 登录获取 * unionId: INTERNAL 或者 wechat

请求成功: 返回json数据