Netless

Netless

  • 通用文档
  • 常见问题
  • JavaScript
  • Android
  • iOS
  • Server
  • GitHub
  • 🇬🇧 English

›服务端 API

产品概述

  • 简要说明

服务端 API

  • 请求规范
  • 白板基础 API
  • 获取封面 API
  • 场景管理 API
  • 文档转图片(静态文档转换)
  • 文档转网页(动态文档转换)
  • Postman 配置文件

请求规范

API 请求域名

https://cloudcapiv4.herewhite.com

全局使用参数

阅读 接入准备,注册账号,获取该 token。

  • {{token}} 参数

sdk 服务器,通过 URL 参数中的 token 进行用户验证。

  • {{roomtoken}} 参数

用户在调用 获取白板 roomtoken 后得到的参数,用于调用部分房间 api

请求格式

对于 POST 和 PUT 请求,请求的主体必须是 JSON 格式,而且 HTTP header 的 Content-Type 需要设置为 application/json

响应格式

对于所有的请求,响应格式都是一个 JSON 对象。

一个请求总会包含 code 字段,200 表示成功,成功的响应附带一个 msg 字段表示具体业务的返回内容:

{
    "code": 200,
    "msg": {
        "room": {
            "id": 10987,
            "name": "111",
            "limit": 0,
            "teamId": 1,
            "adminId": 1,
            "uuid": "5d10677345324c0cb3febd3291e2a607",
            "updatedAt": "2018-08-14T11:19:04.895Z",
            "createdAt": "2018-08-14T11:19:04.895Z"
        },
        "roomToken": "xx"
    }
}

当一个请求失败时响应的主体仍然是一个 JSON 对象,但是总是会包含 code 和 msg这两个字段,你可以用它们来进行调试,举个例子:

{
  "code": 112,
  "msg": "require uuid"
}
Last updated on 6/22/2020 by rick
← 简要说明白板基础 API →
  • API 请求域名
  • 全局使用参数
  • 请求格式
  • 响应格式
Netless
接入即互动
产品
管理控制台官网网站Demo 体验Github
公司
加入我们服务条款隐私协议
联系方式
support@netless.link社区
Copyright © 2020 Netless