MyPackage_api

Installation

For Node.js

npm

install it via:

npm install my_package_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var MyPackageApi = require('my_package_api');

var api = new MyPackageApi.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.v1EndpointsGET(callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MyPackageApi.DefaultApi | v1EndpointsGET | GET /v1/endpoints | List available endpoints MyPackageApi.DefaultApi | v1HubGET | GET /v1/hub | Get information about a hub based on the provided API key MyPackageApi.DefaultApi | v1HubPOST | POST /v1/hub | Create a new hub MyPackageApi.DefaultApi | v1ProductPOST | POST /v1/product | Create a new product MyPackageApi.DefaultApi | v1ProductPUT | PUT /v1/product | Update an existing product MyPackageApi.DefaultApi | v1WhitelistDELETE | DELETE /v1/whitelist | Remove a user from the whitelist for a specific product MyPackageApi.DefaultApi | v1WhitelistGET | GET /v1/whitelist | Check if a user is whitelisted for a specific product MyPackageApi.DefaultApi | v1WhitelistPOST | POST /v1/whitelist | Add a user to the whitelist for a specific product

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.