CatchPoint API - JS Wrapper
JS based API wrapper to call catchpoint functionality (https://io.catchpoint.com/ui/help)
Contributing
- Please open PR's against
develop
branch - Install dependencies via
npm install
and gulp vianpm install -g gulp
- Add functionality and contribute tests in the
tests
directory - run
gulp test
Documentation
Initialization
const CatchPointAPI = ; const catchPoint = ;
Authentication
catchPointauthorization
Adding access token to client
catchpoint;
Auth Example
const CatchPointAPI = ; const catchPoint = ; catchPointauthorization
Nodes
Get all nodes
- Requires authentication
catchPointnodes
Get specific node
- Requires authentication
catchPointnodes
Node Groups
Get all node groups
- Requires authentication
catchPointnodeGroups
Get specific node group
- Requires authentication
catchPointnodeGroups
Folders
Get all folders with filtering.
- Requires authentication
const filterParams = divisionId: 123 // optional productId: 1234 // optional parentFolderId: 1234 // optional statusId: 12 // optional name: 'name' // optional pageNumber: 1 // optional pageSize: 10 // optional ; catchPointfolders
Get specific folder
- Requires authentication
catchPointfolders
Products
Get all products with filtering.
- Requires authentication
const filterParams = divisionId: 123 // optional statusId: 12 // optional name: 'name' // optional pageNumber: 1 // optional pageSize: 10 // optional ; catchPointproducts
Get specific product
- Requires authentication
catchPointproducts