https://dev.izhiju.cn/help/ Recent content on 产品文档 Hugo -- gohugo.io zh https://dev.izhiju.cn/help/userauthentication/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/userauthentication/ API的文档位于 https://dev.izhiju.cn/doc/ 所有接口通过http请求实现，通过header，query 传递参数，body发送数据。数据和返回都采用json格式。 为了通过API访问REST资源，需要一个身份验证令牌。可以通过执行身份验证API轻松获取 token。在api调用时附带token可认证所有除登录接口以外的api接口。 1. 用户登录接口 接口描述： 请求地址：https://dev.izhiju.cn/api/v1/authentication/user 请求方法：POST 请求body： { "username": "string", // string替换为字符串类型的用户名 "password": "string" // string 替换为字符串类型的密码 } 请求成功返回结果： { "type": "accessToken", "id": "bMw5KOJMFfM", "scopeId": "QJaWfWI9fyI", //公司标识id，预先分配好 "createdOn": "2020-02-19T02:44:46.000Z", //token创建时间 "createdBy": "KeiN_96ZIUE", "modifiedOn": "2020-02-19T02:44:46.000Z", "modifiedBy": "KeiN_96ZIUE", "optlock": 1, "tokenId": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJod.PW_z3ySUN4LT99f-X7NhS1Apq", //用于api认证的token，标准jwt格式 "userId": "KeiN_96ZIUE", "expiresOn": "2020-02-19T07:44:46.000Z", //token过期时间 "refreshToken": "1ac4f79d-2155-4f4c-a148-9ad75c2b70e1", //刷新token用 "refreshExpiresOn": "2020-02-20T02:44:46.000Z", //刷新token过期时间 "invalidatedOn": "2020-02-19T07:44:46.000Z" //失效时间 } 授权失败返回结果： { "httpErrorCode": 401, "message": "Error: 18680533727", "kapuaErrorCode": "INVALID_LOGIN_CREDENTIALS" } kapuaErrorCode 结果如下： https://dev.izhiju.cn/help/smarpen/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/smarpen/ API的文档位于 https://dev.izhiju.cn/api/doc/ 该文档可通过Swagger UI获得，极大地帮助测试和探索公开的服务。 为了通过API访问REST资源，需要一个身份验证令牌。幸运的是，可以通过执行身份验证API轻松获取令牌。有几种方法可以调用API，一种简单的方法是使用Swagger UI： 用户名：text 密码：xxxx 用户登录接口请查看：用户接口 1. 检测账户是否存在接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-SmartPenfs/check_the_userName 参数： scopeId: BN8LaC9ZVN8(固定值) userName:用户名 key: 邮件(固定值) 请求成功： 2. 获取验证码接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-SmartPenfs/create_an_smartpenfs 参数： scopeId: BN8LaC9ZVN8(固定值) phoneNumber:手机号码 key: 邮件 (固定值) product：邮件(固定值) 请求成功： 手机即可获取六位数验证码（验证码有效期为五分钟） 3. 注册登陆按钮接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-SmartPenUser_Registers/SmartPenRegisters_login 参数： scopeId: BN8LaC9ZVN8(固定值) Yzm:输入手机获取到的验证码。 Phonenumber:手机号码。 password:输入密码(包含大小写,特殊符号 数字 长度不能少于12位)。 请求成功： 然后进行授权 请查看：用户接口 https://dev.izhiju.cn/help/ota/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/ota/ API的文档位于 https://dev.izhiju.cn/api/doc/ 该文档可通过Swagger UI获得，极大地帮助测试和探索公开的服务。 为了通过API访问REST资源，需要一个身份验证令牌。幸运的是，可以通过执行身份验证API轻松获取令牌。有几种方法可以调用API，一种简单的方法是使用Swagger UI： 用户名：text 密码：xxxx 二维码 （传入设备参数scene_id参数必须是9位int整数，生成的二维码为临时二维码有效期30天，具体调用操作如下） 用户登录接口请查看：用户接口 1. OTA升级接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-AppVersions/appVersions_Update 参数： * * deviceid: 设备id （添加限制） * version: 版本 （输入 “0” 获取最大的版本） * package: 包名 （必传） * scopeId: 登录用户获取 请求成功： 返回json数据： 2. Admin 用户使用说明 登陆网址：https://dev.izhiju.cn/admin/ 1.首页：页面各区域功能如图中所批注 用户模块：该模块分上下两部分。在上部分：可以在这个模块里面对用户进行操作，有搜索(查询），添加，修改(编辑)，删除；在下部分：此部分需要先选中上面的任一用户，Description是对该用户的一些描述，Credentials是指用户的密码，只有Credential Type的值为PASSWORD才是指用户登陆输入的密码，其他类型是用户的其他登陆方式的密码（预留扩展部分），在这部分里可以对密码增改删操作。 版本管理模块：该模块分成上下两部分，上面是指各个固件，可对进行增删改查操作，下面是指各个固件的版本(需要先点击任一固件，才会出现版本），也可进行增删改查操作。 特别注意，包名是硬件的唯一标识，固件包名一般以 ota.system. 开头，加上android发布时自定义的型号， 版本信息中的版本区分大小写，需要完全按照固件提供方给出的版本信息填写。 版本类型中 all代表全量升级包，patch是差分包。 版本说明将会显示在升级界面上，需要注意分行格式，确保在相框上显示正常。 https://dev.izhiju.cn/help/meeting/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/meeting/ API的文档位于 https://dev.izhiju.cn/mapi/doc/ 为了通过API访问REST资源，需要一个身份验证令牌。可以通过执行身份验证API轻松获取令牌。有几种方法可以测试API，一种简单的方法是使用Swagger UI： 1. 用户登录接口 请求方法： POST 请求URL：https://dev.izhiju.cn/mapi/v1/authentication/user 请求头参数：accept: application/json Content-Type: application/json 请求体（json格式）： { "username": "string", "password": "string" } 在线测试 可打开URL https://dev.izhiju.cn/mapi/doc/#!/Authentication/authenticationUser 点击try it out 输入参数： “username”: 账号, “password”: 密码 。 然后点击 excute 请求成功： 系统将返回JSON对象 复制字段tokenId的值（tokenId 有效时间三十分钟） 将值粘贴到网页顶部标有api_key的框中即可 请求失败： 系统将返回 ‘401’错误信息如下 INVALID_LOGIN_CREDENTIALS 密码错误 UNKNOWN_LOGIN_CREDENTIAL 账号没找到 LOCKED_LOGIN_CREDENTIAL 账号锁定 DISABLED_LOGIN_CREDENTIAL 账号禁用 EXPIRED_LOGIN_CREDENTIALS 密码过期 Swagger会自动将身份验证令牌添加到使用Swagger UI完成的每个后续请求中。您已准备好尝试执行记录的API。 https://dev.izhiju.cn/help/weather/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/weather/ API的文档位于 https://dev.izhiju.cn/api/doc/ 该文档可通过Swagger UI获得，极大地帮助测试和探索公开的服务。 为了通过API访问REST资源，需要一个身份验证令牌。幸运的是，可以通过执行身份验证API轻松获取令牌。有几种方法可以调用API，一种简单的方法是使用Swagger UI： 用户名：text 密码：xxxx 二维码 （传入设备参数scene_id参数必须是9位int整数，生成的二维码为临时二维码有效期30天，具体调用操作如下） 用户登录接口请查看：用户接口 1. 获取当前IP地址接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-GeoCity/Gets_ip_address_of_localhost 直接 try 请求成功：返回ip地址数据： 2. IP地址查询城市接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-GeoCity/Get_citys_by_ip 参数： * * ip: IP地址 * locate: 中英文 （输入 “zh” 获取中文,输入 “en” 获取英文。默认英文） 请求成功： 返回json数据： 3. 城市查询接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-GeoCity/Get_citys_by_name 参数： * * * cityname: 城市名 （输入 “武汉” ,locate 填写 zh，输入 “wuhan” ,locate 填写 en ） * locate: 中英文 请求成功： 返回json数据：如上图 https://dev.izhiju.cn/help/smartapp/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/smartapp/ API的文档位于 https://dev.izhiju.cn/doc/ 为了通过API访问REST资源，需要一个身份验证令牌。可以通过执行身份验证API获取令牌。 用户登录认证，注册和找回密码接口请查看：用户接口 1. 设备绑定接口 打开URL https://dev.izhiju.cn/doc/#!/ZJ-Userdevice_binding_process/Create_an_ZjUserDevice 参数： unionId: 用户名 例如:“yeker”,第一次用户绑定都会是owner（就是你登录的用户。只有owner存在才能创建其他用户） deviceId: 注册的设备id 例如：“1232212233” 请求成功： 返回json数据： message: code: (可根据以下返回编码做判断，编码请忽略大小写判断) UserNotExist: 用户不存在 DeviceIdNotExist:没找到对应的设备 Success:设备分享成功 ownerIsBinding: 主人已绑定 IsNotOwner: 非主人无权绑定 OwnerExist:主人已存在，无需重复绑定 UserBindingExist:用户已绑定，无需重复操作。 OwnerBindingSuccess:绑定设备成功，恭喜你成为主人。 2. 查询设备详情消息接口 打开URL https://dev.izhiju.cn/doc/#!/ZJ-Userdevice_binding_process/Get_DeviceId_Details 参数： scopeId: 登录用户获取 deviceId: 注册的设备id 例如：“1232212233” 请求成功： 返回json数据： https://dev.izhiju.cn/help/panel/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/panel/ API的文档位于 https://dev.izhiju.cn/doc/ 为了通过API访问REST资源，需要一个身份验证令牌。可以通过执行身份验证API获取令牌。 用户登录认证，注册和找回密码接口请查看：用户接口 1. 注册设备接口 打开URL https://dev.izhiju.cn/doc/#/Device/deviceCreate 参数： * * clientId: 设备id 例如：“1232212233” * status: “ENABLED” * modelId: " " 例如–（空调 面板 灯 窗帘） * scopeId: 登录用户获取 请求成功： 返回json数据： 2. 设备绑定接口 打开URL https://dev.izhiju.cn/doc/#!/ZJ-Userdevice_binding_process/Create_an_ZjUserDevice 参数： unionId: 用户名 例如:“yeker”,第一次用户绑定都会是owner（就是你登录的用户。只有owner存在才能创建其他用户） deviceId: 注册的设备id 例如：“1232212233” 请求成功： 返回json数据： message: code: (可根据以下返回编码做判断，编码请忽略大小写判断) UserNotExist: 用户不存在 DeviceIdNotExist:没找到对应的设备 Success:设备分享成功 ownerIsBinding: 主人已绑定 IsNotOwner: 非主人无权绑定 OwnerExist:主人已存在，无需重复绑定 UserBindingExist:用户已绑定，无需重复操作。 OwnerBindingSuccess:绑定设备成功，恭喜你成为主人。 3. https://dev.izhiju.cn/help/wechatdpf/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/wechatdpf/ API的文档位于 https://dev.izhiju.cn/api/doc/ 该文档可通过Swagger UI获得，极大地帮助测试和探索公开的服务。 为了通过API访问REST资源，需要一个身份验证令牌。幸运的是，可以通过执行身份验证API轻松获取令牌。有几种方法可以调用API，一种简单的方法是使用Swagger UI： 用户名：text 密码：xxxx 二维码 （传入设备参数scene_id参数必须是9位int整数，生成的二维码为临时二维码有效期30天，具体调用操作如下） 用户登录接口请查看：用户接口 1. 调用生成二维码接口 打开URL https://dev.izhiju.cn/api/doc/#!/Authentication/authenticationUser 参数： width: 代表二维码的尺寸 sceneId: 填写设备id 请求成功： 返回200 是已经生成成功了二维码（api上没有显示二维码图片），401授权失败，500服务器问题 使用工具方法： 2. 查询设备是否存在接口 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-Devices_ids/Get_an_wxDevice_by_clientId 参数： * clientId: 填写设备id 请求成功： 返回Json数据 Json数据中 islosk==true 无法绑定 3. 扫码绑定 打开URL https://dev.izhiju.cn/api/doc/#!/ZJ-Devices_ids/get_an_wxDevice_by_ticketLink 参数： * ticket: 查询设备是否存在接口返回的json数据中 请求成功： 返回系统Json数据 https://dev.izhiju.cn/help/thankyou/ Mon, 01 Jan 0001 00:00:00 +0000 https://dev.izhiju.cn/help/thankyou/ 椰壳科技 椰壳科技是一家高科技设备方案定制商，我们的设备方案主要来源于椰壳科技，和椰壳科技合作，将智能设备接入我们的云端服务。 腾千里科技 腾千里科技是一家智能笔设计生产商，我们共同合作的智能笔记项目的设备，已经成功接入我们的账户系统，消息系统。