提示

如果您需要专业团队为您和您的企业订制 AIGC 工具可以通过 cube@spap.com 或者 xujiangwei@spap.com 邮箱联系我们。

应用服务器 RESTful API

应用服务器的 RESTful 接口文档。

应用服务器的默认端口： 7777 。

账号管理

账号登录

POST /account/login/

通过指定的账号数据进行登录。登录成功后返回有效的访问令牌。 服务器会尝试将访问令牌写入 Cookie 。

Request Headers:

• Content-Type – application/json

Request JSON Object:

• device (string) – 指定登录账号使用的设备。

• jsCode (string) – 指定登录时获取的 code 。

Response Headers:

• Content-Type – application/json

Response JSON Object:

• code (number) – 状态码。状态码 0 表示成功。

• token (string) – 访问令牌。

• trace (string) – 访问痕迹标识。

• creation (number) – 令牌的创建时间。

• expire (number) – 令牌的超期时间。

账号登出

TODO

关联账号

POST /account/bind/

绑定账号。将指定小程序用户与 Cube 用户进行关联绑定。 绑定成功后自动使用该账号登录。

Request Headers:

• Content-Type – application/json

Request JSON Object:

• device (string) – 指定登录账号使用的设备。

• jsCode (string) – 指定登录时获取的 code 。

• phone (string) – 指定账号的电话号码。与 account 参数二选一。

• account (string) – 指定账号名。账号名为 Email 格式。与 phone 参数二选一。

• password (string) – 指定待绑定账号的密码，使用 MD5 格式。

Response Headers:

• Content-Type – application/json

Response JSON Object:

• code (number) – 状态码。状态码 0 表示成功。

• token (string) – 访问令牌。

• trace (string) – 访问痕迹标识。

• creation (number) – 令牌的创建时间。

• expire (number) – 令牌的超期时间。

账号信息

GET /account/info/

获取指定令牌对应的账号数据。

Query Parameters:

• token (string) – 用户的有效令牌。

Response Headers:

• Content-Type – application/json

Response JSON Object:

• id (number) – 账号的 ID 。

• domain (string) – 账号所属的域。

• account (string) – 账号名。

• phone (string) – 账号的电话号码。

• name (string) – 账号的显示昵称。

• avatar (string) – 账号的头像描述。

• state (number) – 账号状态描述。

• region (string) – 账号的社交区域描述。

• department (string) – 账号的部门描述。

• registration (number) – 账号注册时的时间戳。

分享标签管理

获取分享标签信息

GET /file/sharing/

通过分享码（ Sharing Code ）获取分享标签信息。

Query Parameters:

• token (string) – 用户的有效令牌。

• sc (string) – 分享码。

Response Headers:

• Content-Type – application/json

应答数据的 JSON Object 结构参看 Sharing Tag 。

批量获取分享标签

GET /file/list/sharing/

以批量方式获取该用户创建的分享标签。单次调用的最大数据条目不允许超过30条。

Query Parameters:

• token (string) – 用户的有效令牌。

• begin (number) – 查询数据的起始索引位置。

• end (number) – 查询数据的结束索引位置。

• valid (boolean) – 待查询的分享标签是否是有效的标签。

Response Headers:

• Content-Type – application/json

Response JSON Object:

• list (Array) –

  分享标签列表。分享标签数据结构参看 Sharing Tag 。

• total (number) – 符合条件的总数量。

• begin (number) – 标签列表的起始索引。

• end (number) – 标签列表的结束索引。

• valid (boolean) – 是否是有效的分享标签。

批量获取文件分享的访问记录

GET /file/list/trace/

以批量方式返回文件分享的操作或访问记录。该接口仅返回分享人是当前用户的记录。

Query Parameters:

• token (string) – 用户的有效令牌。

• code (string) – 文件分享码。

• begin (number) – 查询数据的起始索引位置。

• end (number) – 查询数据的结束索引位置。

Response Headers:

• Content-Type – application/json

Response JSON Object:

• list (Array) – 分享访问记录列表。分享访问记录数据结构参看 Visit Trace 。

• total (number) – 记录总条目数。

• sharingCode (string) – 文件分享码。

• begin (number) – 数据列表的起始索引。

• end (number) – 数据列表的结束索引。

提交小程序的操作记录

POST /trace/sharing/applet/wechat/

提交小程序访问或操作记录。

Request Headers:

• Content-Type – application/json

Request JSON Object:

• domain (string) – 访问的域名。

• url (string) – 完整的 URL 。

• title (string) – 标题。

• screen (object) –

  屏幕数据 JSON Object ：

  {
      "width" : 1680,
      "height": 1050,
      "colorDepth" : 30,
      "orientation": "landscape-primary"
  }
  

• language (string) – 平台语言。

• userAgent (string) – 浏览器的 User Agent 描述（ 选填数据 ）。

• agent (object) –

  平台信息代理（ 选填数据 ）：

  {
      "SDKVersion": "2.25.0",
      "appId": "__UNI__75E13B4",
      "appLanguage": "zh-Hans",
      "appName": "CubeBox",
      "appVersion": "1.0.0",
      "appVersionCode": "100",
      "batteryLevel": 100,
      "benchmarkLevel": 1,
      "bluetoothEnabled": true,
      "brand": "devtools",
      "browserName": "",
      "browserVersion": "",
      "cameraAuthorized": true,
      "deviceBrand": "devtools",
      "deviceId": "17578534465635660197",
      "deviceModel": "iPhone X",
      "deviceOrientation": "portrait",
      "devicePixelRatio": 3,
      "deviceType": "phone",
      "enableDebug": false,
      "errMsg": "getSystemInfo:ok",
      "fontSizeSetting": 16,
      "hostFontSizeSetting": 16,
      "hostLanguage": "zh-CN",
      "hostName": "WeChat",
      "hostPackageName": "",
      "hostSDKVersion": "2.25.0",
      "hostTheme": "",
      "hostVersion": "8.0.5",
      "language": "zh_CN",
      "locationAuthorized": true,
      "locationEnabled": true,
      "microphoneAuthorized": true,
      "mode": "default",
      "model": "iPhone X",
      "notificationAuthorized": true,
      "osLanguage": "",
      "osName": "ios",
      "osTheme": "",
      "osVersion": "10.0.1",
      "pixelRatio": 3,
      "platform": "devtools",
      "safeArea": {
          "top": 44,
          "left": 0,
          "right": 375,
          "bottom": 778,
          "width": 375,
          "height": 724
      },
      "safeAreaInsets": {
          "top": 44,
          "left": 0,
          "right": 0,
          "bottom": 34
      },
      "screenHeight": 812,
      "screenWidth": 375,
      "statusBarHeight": 44,
      "system": "iOS 10.0.1",
      "ua": "",
      "uniCompileVersion": "3.4.18",
      "uniPlatform": "mp-weixin",
      "uniRuntimeVersion": "3.4.18",
      "version": "8.0.5",
      "wifiEnabled": true,
      "windowBottom": 0,
      "windowHeight": 724,
      "windowTop": 0,
      "windowWidth": 375
  }
  

• event (string) – 事件名。

• eventTag (string) –

  事件标签（ 选填数据 ）。

  标签：download，open 等

• eventParam (object) –

  事件参数（ 选填数据 ）。

  {
      "sn": 1659533823805,
      "sharer": "gbdcebeeh095",
      "parent": "ZUWVXUXX91082",
      "id": 1898471,
      "domain": "shixincube.com"
  }
  

Response Headers:

• Content-Type – application/json

Response JSON Object:

• time (number) – 记录时间戳。

附录

事件名

事件名	描述	参数说明
Transmit	发送事件	–
Open	打开事件	–
Forward	转发事件	–
Archive	归档事件	–
Delete	删除事件	–
Rename	重命名事件	–
Copy	复制数据事件	–
Share	分享事件	–
View	浏览事件	–
ViewLoss	浏览已丢失的数据事件	–
ViewExpired	浏览已过期的数据事件	–
Extract	提取/下载数据事件	–