2.0.0 • Published 3 years ago

halla_io v2.0.0

Weekly downloads
2
License
Apache-2.0
Repository
-
Last release
3 years ago

halla_io

HallaIo - JavaScript client for halla_io

  • API version: 2.0.0
  • Package version: 2.0.0
  • Build date: 2020-12-18T20:57:19.009Z
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install halla_io --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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.

Getting Started

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

var HallaIo = require('halla_io');

var defaultClient = HallaIo.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['key'] = "Token"

var api = new HallaIo.DefaultApi()

var serviceAccount = "serviceAccount_example"; // {String} Identifies the serviceAccount for authorization purposes.

var opts = { 
  'orders': new HallaIo.Orders() // {Orders} The orders to create.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addOrders(serviceAccount, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.halla.io

ClassMethodHTTP requestDescription
HallaIo.DefaultApiaddOrdersPOST /v2/orders
HallaIo.DefaultApiaddProductsToStorePOST /v2/stores/{cid}/products
HallaIo.DefaultApiaddStorePOST /v2/stores
HallaIo.DefaultApigetProductsGET /v2/products
HallaIo.DefaultApiremoveProductFromStoreDELETE /v2/stores/{cid}/products/{pid}

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: key
  • Location: URL query string