bizzabo-api
v0.2.0
Published
The Bizzabo API is a Typescript client that allows calling Bizzabo public APIs
Downloads
11
Readme
Bizzabo Node.js SDK
This SDK is a wrapper around the Bizzabo Public APIs
Prerequisites
- Node.js version 14 and above.
- A set of API credentials within your Bizzabo Sandbox account (See Create Sandbox Credentials)
Installation
npm install bizzabo-api --save
Create Sandbox Credentials
Go to the APIs page in your Bizzabo account (https://accounts.bizzabo.com/{accountId}/api) and create a new set of API Credentials. Make sure you copy those to a secure place as you will not be able to retrieve the client secret at a later time.
Authentication
This SDK comes with an Auhentication client that allows you to retrieve OAuth 2.0 based JWT tokens per the account for which you're performing your API requests
Retrieve a Token
To get a token run the following code. Note that you need to replace clientId
and clientSecret
with the credentials you obtained earlier and use your Sandbox account id as the accountId
import { AuthenticationBuilder } from 'bizzabo-api';
const CLIENT_ID = '<clientId>' , CLIENT_SECRET = '<clientSecret>', ACCOUNT_ID = '<accountId>';
const auth = new AuthenticationBuilder(CLIENT_ID, CLIENT_SECRET, ACCOUNT_ID).build();
auth.getClientCredentialsToken().then(token => {
// The `token` object contains an access_token that is being used to call the endpoints.
}, (err) => console.error(err));
// or, if you prefer the async/await syntactic sugar
const token = await auth.getClientCredentialsToken();
Example Usage
import { AuthenticationBuilder, ApiClient } from 'bizzabo-api';
// Get auth token
const auth = new AuthenticationBuilder('pfTIxlfvPZ...', 'wodXksxANQi6eq...', 521477).build();
const token = await auth.getClientCredentialsToken();
// Initialize the relevant clients; in this example, the Contacts client.
const sdk = new ApiClient(token);
const contactsApi = sdk.contacts;
// Get a contact by their email
const contact = await contactsApi.getContactByEmail(394740, '[email protected]');
if (!contact) {
console.error('Contact does not exist');
} else {
console.log(contact);
}
Using this SDK
This SDK exports all the relevant typings, so you can use the built-in functions with confidence. Use a popular IDE such as VSCode or Webstorm to get the code hints from these typings
API Documentation
You can get the full documentation for the API on the API Docs page