ob1y2k / publitio_js_sdk

Simple JS SDK for Publitio API

Publitio JS SDK

JavaScript SDK for the Publitio API.

Installation

Using npm:

$ npm install publitio_js_sdk

Using yarn:

$ yarn add publitio_js_sdk

Usage

This library runs both in Node and in the browser. When using this library in the browser, note that it is in UMD format. This means you can load it either as a simple <script> tag, or using RequireJS. You should always load publitio-api.min.js in the browser.

Using require in Node:

const PublitioAPI = require('publitio_js_sdk').default
const publitio = new PublitioAPI('<API key>', '<API secret>')

Using RequireJS in the browser:

requirejs(
  ['node_modules/publitio_js_sdk/build/publitio-api.min.js'],
  PublitioAPI => { /*...*/ }
)

Using <script> tags:

<script src="node_modules/publitio_js_sdk/build/publitio-api.min.js"></script>

Using ES6 modules in Node:

import PublitioAPI from 'publitio_js_sdk'
const publitio = new PublitioAPI('<API key>', '<API secret>')

Using ES6 modules in the browser (for example, with Webpack or Browserify):

import PublitioAPI from './node_modules/publitio_js_sdk/build/publitio-api.min.js'
const publitio = new PublitioAPI('<API key>', '<API secret>')

The reason why you should import publitio-api.min.js in the browser is so that Webpack or Browserify wouldn't include Node-specific modules in your build, making your bundle needlessly large.

Examples

Sample API call to list files:

publitio.call('/files/list', 'GET', { offset: '0', limit: '10'})
        .then(response => { console.log(response) })
        .catch(error => { console.log(error) })

See the examples directory for useful examples and check the official Publitio docs.

For legacy reasons, the following is also allowed:

import { publitioApi } from 'publitio_js_sdk'
const publitio = publitioApi('<API key>', '<API secret>')

The publitioApi function is deprecated and should be avoided.