Package Exports
- qansigliere-revelsystems-api-integration
- qansigliere-revelsystems-api-integration/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (qansigliere-revelsystems-api-integration) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Revel Systems API Integration
The main idea of this library created in the JavaScript language is to provide a ready-made set of API methods for integration with Revel Systems Management Console
Author
https://www.youtube.com/@QANSIGLIERE/
Support the project
https://buymeacoffee.com/qansigliere
Installation
Using npm npm i qansigliere-revelsystems-api-integration
How to use it
Create a *.env file
Create any *.env file (like revelsystems.env) and write the following information in the created file
export REVELSYSTEMS_URL="https://__YOUR_URL__"
export REVELSYSTEMS_APIKEY="__YOUR_APIKEY__"
export REVELSYSTEMS_APISECRET="__YOUR_APISECRET__"Make the *.env file works
Just run in the terminal the following command: source yourfile.env
Address
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getAddressByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadAddress(false);Employee
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getEmployeeByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadEmployee('2021-03-19T15:55:59.507984');Establishment
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getEstablishmentByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadEstablishment();Order
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getOrderByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadOrder();Version
Get an object
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getVersion();OrderAllInOne
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getOrderAllInOneByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadOrderAllInOne();OrderDataDiff
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getOrderDataDiffByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadOrderDataDiff();OrderExchange
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getOrderExchangeByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadOrderExchange();OrderExchangeItem
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getOrderExchangeItemByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadOrderExchangeItem();OrderHistory
Get any specific object by id
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.getOrderHistoryByID(1);Download all filtered records
let apiRequest = new RevelSystemsAPI();
let resp = await apiRequest.downloadOrderHistory();