Wolkabout / wolk-rest

WolkAbout's Node.js/Web client library for accessing WolkAbout APIs

WolkAbout client library

Node.js/Web client library for using WolkAbout REST APIs.

Getting Started

Installation

This library is distributed on npm. In order to add it as a dependency, run the following command:

$ npm install @wolkabout/wolk-rest

First example

Create a new instance of the WolkREST with your baseURL and SessionStorage [optional].

const wolkREST = new WolkREST('https://api-demo.wolkabout.com');

// continue by signing in
async () => {
  const user = await wolkRest.auth().emailSignIn({
    username: 'YOUR_EMAIL',
    password: 'YOUR_PASSWORD'
  });
};

Samples

There are several samples. If you're trying to figure out how to use an API ... look there first! If there's a sample you need missing, feel free to file an issue.

Reference API

This library provides generated Reference API documentation.

Contributing

Contributions are always welcome! Please read the contribution guidelines first.

• Contributing guide
• Code of Conduct

License

This library is licensed under Apache 2.0.