CatchPoint API - JS Wrapper
JS based API wrapper to call catchpoint functionality (https://io.catchpoint.com/ui/help)
Contributing
- Please open PR's against
developbranch - Install dependencies via
npm installand gulp vianpm install -g gulp - Add functionality and contribute tests in the
testsdirectory - run
gulp test
Documentation
Initialization
const CatchPointAPI = require('catchpoint-api');
const catchPoint = new CatchPointAPI();Authentication
catchPoint.authorization.createSession({
clientId: 'myClientId',
clientSecret: 'myClientSecret'
}).then((response) => {
console.log("my token is: ", response.access_token);
}).catch((error) => {
console.error(error);
})Adding access token to client
catchpoint.setAccessToken('myToken');Auth Example
const CatchPointAPI = require('catchpoint-api');
const catchPoint = new CatchPointAPI();
catchPoint.authorization.createSession({
clientId: 'myClientId',
clientSecret: 'myClientSecret'
}).then((response) => {
catchpoint.setAccessToken(response.access_token);
}).catch((error) => {
console.error(error);
})Nodes
Get all nodes
- Requires authentication
catchPoint.nodes.getAll().then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})Get specific node
- Requires authentication
catchPoint.nodes.getById({id: 123}).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})Node Groups
Get all node groups
- Requires authentication
catchPoint.nodeGroups.getAll().then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})Get specific node group
- Requires authentication
catchPoint.nodeGroups.getById({id: 123}).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})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
};
catchPoint.folders.getAll(filterParams).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})Get specific folder
- Requires authentication
catchPoint.folders.getById({id: 123}).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})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
};
catchPoint.products.getAll(filterParams).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})Get specific product
- Requires authentication
catchPoint.products.getById({id: 123}).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
})
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent