UNAS API Node.js

A Typescript wrapper for the UNAS API.

Please refer to the linked documentation for details!

All functions are available directly on the main UnasInstance object.

The package handles authentication internally, so you don't have to deal with it, just provide your API key to the UNAS instance.

It also features a built-in two-way conversion between XML and JSON as UNAS uses XML message bodies.

Current limitations:

• Only the GET endpoints are implemented for now, you cannot execute any SET methods!
• The message conversion might produce incorrect XML messages as it is not fully tested, so some filtered requests may return data non-related to the given filter or the responses may not contain certain data! Please open an issue if you encounter such a problem!

Installation:

$ npm install unas-api

Initialization

This module exports an async initialization function which takes a config object.

initializeUnas(config);

Arguments

• config - Required - A plain JavaScript object that contains the configuration options.

Options

• apiKey - Required - An UNAS provided API key.

Example:

const unas = await initializeUnas({
  apiKey: <YOUR_UNAS_API_KEY>,
});

Error handling

In case of any non-2xx status codes, an HttpError will be thrown, containing the statusCode and message.

Contributing

This library welcomes all constructive contributions. Contributions take many forms, from code for bug fixes and enhancements, to additions and fixes to documentation, additional tests, triaging incoming pull requests and issues, and more!

Maintainer

Iamtazy

License

MIT