Overview

This is the official documentation for deskree-js, the JavaScript SDK of the Deskree platform.

Installation

Install the Deskree SDK using npm:

npm install @deskree/deskree-js@latest axios --save

deskree-js is using axios as a dependency. Hence, it must be installed in your package.json for the SDK to work.

Initial Setup

For NodeJS backend projects, import the createClient method and instantiate the client by passing the required configurations.

import createClient from '@deskree/deskree-js'
import axios from 'axios'

const options = {
  projectId: "YOUR_PROJECT_ID",
  axios: axios
}

/* Optional options
* adminToken: this is the access token that you can get from Settings/Access Token
* userToken: this is the token created with the user sign in workflow
*/

const client = createClient(options)

Read more about createClient() Method

Authorization

To learn about authorization flow, visit Authorization

List of Modules

Database ModuleAuthorizationIntegrations ModuleConfig Module