智能笔记

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

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

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

  • 用户名:text 密码:xxxx
  • 用户登录接口请查看:用户接口

1. 检测账户是否存在接口

  • 参数:
  • scopeId: BN8LaC9ZVN8(固定值)
  • userName:用户名
  • key: 邮件(固定值)

请求成功:

  • 调用生成二维码接口

2. 获取验证码接口

  • 参数:
  • scopeId: BN8LaC9ZVN8(固定值)
  • phoneNumber:手机号码
  • key: 邮件 (固定值)
  • product:邮件(固定值)

请求成功: 手机即可获取六位数验证码(验证码有效期为五分钟)


3. 注册登陆按钮接口

  • 参数:
  • scopeId: BN8LaC9ZVN8(固定值)
  • Yzm:输入手机获取到的验证码。
  • Phonenumber:手机号码。
  • password:输入密码(包含大小写,特殊符号 数字 长度不能少于12位)。

请求成功: 调用生成二维码接口 然后进行授权 请查看:用户接口


4. 上传文件接口

  • 参数:
    • groupId: 一级目录 (必输项)
    • groupId_describe: 一级目录描述
    • data_type: 文件类型(必输项)。
    • data_file_name: 文件名(必输项)。
    • bookId :不强制传值
    • pageId :不强制传值

请使用工具操作请求API:

  • 调用生成二维码接口 请求成功: 返回200 查看文件请看下面接口

5. 查看上传文件和查看目录列表

  • 参数:
    • scopeId: 登录中获取(必输项)
    • project : 值为smartpen (固定值 必输项)
    • userName :登录用户名(必输项)
    • groupId: 一级目录(上传文件填写的groupId)
    • data_file: 上传文件填写的data_type。

请求成功:

  • 查看用户下的一级目录:

    • 调用生成二维码接口
  • 查看用户下groupId目录下的文件类型目录:

    • 调用生成二维码接口
  • 查看用户下groupId目录下的文件类型目录下面的文件: 调用生成二维码接口


6. 下载文件接口

  • 调用生成二维码接口
  • 例如下载url:https://dev.izhiju.cn/api/data/smartpen/13581448730/smartpen/1/text/8.png * https://dev.izhiju.cn/api/data 固定 * smartpen 登录的账号所属公司下的 例如(可以换成yeker公司) * 13581448730 登录的账号 例如(可以换成yeker公司下的用户账号) * smartpen 固定值 * 1 上传文件填写的groupId * text 上传文件填写的data_type * 8.png 文件名

请求成功: 如上图得到图片