Netless

Netless

  • JavaScript
  • Android
  • iOS
  • Server
  • FAQ
  • GitHub
  • 🇨🇳 中文

›Server API

Overview

  • Introduction

Server API

  • Request specification
  • Whiteboard basics API
  • Get cover API
  • Scene management API
  • Document to Picture
  • Document to Web Page
  • Postman configuration file

Scene management API

Insert new scene

Scene is a relatively abstract concept, which can be a page of PPT or a blank whiteboard. For details, please refer to Scene Management

POST /rooms/{{uuid}}/scenes

  • Header parameter
FieldTypeDescription
roomTokenstring{{roomtoken}}
  • body parameter
FieldTypeDescription
basePathstringbase folder
startIndexnumberAfter the first few pages of the current file, 0 is inserted before the first page, 1 is between the first and second pages, and so on
scenesscene arrayInserted into a set of scenes, which may correspond to a set of PPT
  • scene definition
FieldTypeDescription
namestringbase folder
ppt (optional){width: number, height: number, src: string}ppt width, height, path (path can be a picture address that starts with https: // or a dynamic ppt address that starts with the pptx: // protocol)
  • body sample
{
    "basePath": "/dir",
    "startIndex": 0,
    "scenes": [
        {
            "name": "ppt1",
            "ppt": {
                "width": 1024,
                "height": 768,
                "src": "https://white-pan.oss-cn-shanghai.aliyuncs.com/101/image/Rectangle.png"
            }
        },
        {
            "name": "ppt2",
            "ppt": {
                "width": 1024,
                "height": 768,
                "src": "https://white-pan.oss-cn-shanghai.aliyuncs.com/101/image/alin-rusu-1239275-unsplash_opt.jpg"
            }
        }
    ]
}

Note: This interface can only enter room token

Update scene path

Scenes can be switched to reflect the effect of turning pages on PPT.

PUT /rooms/{{uuid}}/scenepath

  • header parameter
FieldTypeDescription
roomTokenstring{{roomtoken}}
  • body parameter
FieldTypeDescription
pathstringscene path
  • body sample
{
    "path": "dir/ppt1"
}

Note: This interface can only enter room token

Last updated on 1/13/2020 by 伍双
← Get cover APIDocument to Picture →
  • Insert new scene
  • Update scene path
Netless
Let's interactive.
Product
ConsoleHomepageDemoGithub
Company
Join usServicePrivacy
Contact
support@netless.linkCommunity
Copyright © 2020 Netless