Skip to content

adrianba/supernote-cloud-api

Repository files navigation

Supernote Cloud Storage API

Build and test badge npm version badge license badge

(Unofficial) API for accessing the cloud storage for Supernote tablets. This library was created by observing the network calls from the Supernote web app and may stop working if Supernote modifies the cloud API.

Modules

supernote-cloud-api

Functions

login(email, password)Promise.<string>

Login to SuperNote Cloud API.

fileList(token, directoryId)Promise.<FileInfo>

Return contents of folder.

fileUrl(token, id)Promise.<string>

Obtain URL to contents of file.

syncFiles(token, localPath)Promise.<void>

Sync files from cloud to local file system.

supernote-cloud-api

login(email, password) ⇒ Promise.<string>

Login to SuperNote Cloud API.

Kind: global function
Returns: Promise.<string> -

Access token to access storage

Param Type Description
email string

User e-mail address

password string

User password

fileList(token, directoryId) ⇒ Promise.<FileInfo>

Return contents of folder.

Kind: global function
Returns: Promise.<FileInfo> -

List of files and folders.

Param Type Description
token string

Access token from login()

directoryId string

Identifier of folder to list (default is root folder)

fileUrl(token, id) ⇒ Promise.<string>

Obtain URL to contents of file.

Kind: global function
Returns: Promise.<string> -

URL of file

Param Type Description
token string

Access token from login()

id string

Identifier of file

syncFiles(token, localPath) ⇒ Promise.<void>

Sync files from cloud to local file system.

Kind: global function

Param Type Description
token string

Access token from login()

localPath string

Local file path to sync to