simple-vertec-api
v5.0.1
Published
Simple Vertec Api for node.js
Downloads
48
Readme
Simple Vertec Api
Simple Vertec Api is an simple wrapper around www.vertec.com XML webservice for node.js. It features solid CRUD support for dealing with Vertec's data.
Delimination and Responsibility
This XML wrapper will only give you a simpler way of making requests via Vertec's own XML interface. There won't be any validations done for data input (you have to do it yourself or rely on Vertec's validation as it is their responsibility on server side).
Version 3 offers additional query options for further transforming response data, included caching support, parallel request mode and many more. Take a look at the documentation.
Version 4 supports Vertec's new token based authorization.
Version 5 supports Vertec's new API key based authorization.
Installation
Run this command:
$ npm install simple-vertec-api --save
Example for a simple query request fetching all active users
import {SimpleVertecApi, SimpleVertecQuery} from 'simple-vertec-api';
const api = new SimpleVertecApi('http://localhost', 'my-api-key', true);
SimpleVertecQuery.setApi(api);
new SimpleVertecQuery()
.whereOcl('Projektbearbeiter')
.whereSql('aktiv = 1')
.orderBy('name')
.addFields('name', 'kuerzel')
.get()
.then(function(response) {
// do something with the result
console.log(response);
});
Example for a raw api request
import {SimpleVertecApi} from 'simple-vertec-api';
const api = new SimpleVertecApi('http://localhost', 'my-api-key', true);
// searches for some records starting from day X
const select = {
ocl: 'Leistung',
sqlwhere: "(text like '%?%') and (CreationDateTime >= {ts '? 00:00:00'})",
sqlorder: 'datum'
};
const params = [
'search text',
'2015-08-22'
];
const fields = [
'minutenInt',
'minutenExt',
'datum',
'text'
];
api.select(select, params, fields).then(function(response) {
// do something with the result
console.log(response);
});
Versioning
From 2.0.0 and up Simple Vertec Api
follows SEMVER.
Resources
Contributing
- Fork it!
- Create your feature branch (
git checkout -b feature/my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin feature/my-new-feature
) - Create new Pull Request
Author
Dimitri König (@dimitrikoenig)
License
The Simple Vertec Api is open-sourced software licensed under the MIT license