README
Bappsy node.js sdk
This SDK will help you to build your own Integrations for Business Application System (Bappsy) by hochdreih. If you are not already a Customer you can get your account here The Bappsy API provides you with over 400 Data Models and around 2500 Endpoints.
Bappsy can manage nearly everything that is required to run a modern Enterprise
Installation
npm i -S @hochdreih/bappsy
Authentication
- Get your API Key
- Set up your App
- Put the API Key in
process.env.BAPPSY_API_KEY
- or provide it in the constructor
const bappsy = new Bapsy(<yourAPIKey>)
- Put the API Key in
Test
npm test
Examples
General Usage (Typescript)
import {Bappsy} from "@hochdreih/bappsy"
const bappsy = new Bapsy()
(async () => {
try {
const consumers = await bappsy.get('consumers');
const consumer = await bappsy.getDetail('consumers', consumers[0]._id)
console.log(consumer.sr);
} catch (e) {
// Deal with the fact the chain failed
}
})();
Consumer (The Main Data Model )
Get all Consumers of type lead and filter for fields
import {BappsyConsumer,ConsumerTypes} from "@hochdreih/bappsy"
const consumer = new BappsyConsumer();
(async () => {
try {
const leads = await consumer.getAllByType(ConsumerTypes.LEAD, 'first_name last_name email last_active');
debug(leads);
} catch (e) {
// Deal with the fact the chain failed
}
})();
Use Endpoints directly
The SDK Provides you with .get() .getDetail .create() .update() .delete()
methods for general data manipulation
Find all Endpoints in the API Documentation
Credits
Made with ❤️ at Tegernsee and Erding by hochdreih