@vbasoftware/vbapi-vbasoftware-js v1.0.0

vba_software

VbaSoftware - JavaScript client for vba_software APIs for VBASoftware This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 0.0.1

Installation

For Node.js

npm

Install via:

npm install vbapi-vbasoftware-js --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

Request an API Key

VBASoftware APIs require a client API Key. You may request a key via your VBA account manager or by sending a request via email.

Implementing

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

var VbaSoftware = require('vbapi-vbasoftware-js');
var defaultClient = VbaSoftware.ApiClient.instance;

// Configure API key authorization: VBAPIKey
var VBAPIKey = defaultClient.authentications['VBAPIKey'];
VBAPIKey.apiKey = "YOUR API KEY"

var api = new VbaSoftware.AmountDetailsApi()
var vbapi_client_code = "vbapi_client_code_example"; 		// {String} Client code
var vbasoftware_database = "vbasoftware_database_example"; 	// {String} Target database
var clientId = "clientId_example"; 							// {String} Client ID
var key = "key_example"; 									// {String} Key

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAmountDetails(vbapi_client_code, vbasoftware_database, clientId, key, callback);

Documentation for API Endpoints

All URIs are relative to https://vbapi-dev.vbasoftware.com/vbasoftware