presentator-client v2.7.1

Presentator v2 REST API JS client

Simple and compact (~7kb gzip) JavaScript client (browser and node.js) for the Presentator v2 REST API (based on axios HTTP client).

• Installing
• Usage
• Development

This repository is READ-ONLY. Report issues and send pull requests in the main Presentator repository.

Installing

Using npm

npm install presentator-client --save

ES6-style import:

import PresentatorClient from 'presentator-client'

Manual

<script src="/path/to/dist/client.min.js"></script>

Example

var client = new PresentatorClient('my_api_url');

client.Users.login('test@example.com', 'my-password').then(function (data) {
    // success...
    // see axios response schema - https://github.com/axios/axios#response-schema
}).catch(function (e) {
    // error...
});

Usage

Creating new client instance

var client = new PresentatorClient(baseUrl = '', token = '', axiosConfig = {});

Instance methods

Each instance method returns the PresentatorClient instance to allow chaining.

API resources/services

Each resource call returns a Promise object. More detailed API docs related to the resources could be found here.

Development

# build and minify for production
npm run build

# run unit tests
npm test