@deskree/deskree-js

Overview

Documentation

This is the official documentation of deskree-js - Javascript SDK of the Deskree platform.

For a better visual experience visit our documentation page.

Installation

Install the Deskree SDK using npm:

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

{% hint style="warning" %} deskree-js is using axios as a dependency. Hence, it must be installed in your package.json for the SDK to work. {% endhint %}

Initial Setup

Import the createClient method for NodeJS backend projects and create an instance of the client passing the configurations required:

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.md

Authorization

To learn about authorization flow, visit authorization.md

List of Modules

• database-module
• auth-module
• integrations-module