merge_ticketing_api
MergeTicketingApi - JavaScript client for merge_ticketing_api
The unified API for building rich integrations with multiple Ticketing platforms.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit https://www.merge.dev/
Installation
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install merge_ticketing_api --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your merge_ticketing_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/merge-api/merge-ticketing-javascript
then install it via:
npm install merge-api/merge-ticketing-javascript --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 MergeTicketingApi = require('merge_ticketing_api');
var defaultClient = MergeTicketingApi.ApiClient.instance;
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY"
var api = new MergeTicketingApi.AccountDetailsApi()
var x_account_token = "x_account_token_example";
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.accountDetailsRetrieve(x_account_token, callback);
Documentation for API Endpoints
All URIs are relative to https://api.merge.dev/api/ticketing/v1
Documentation for Models
Documentation for Authorization
tokenAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header