Generate private API keys to set up a new integration with Bloomerang CRM using the REST API. You can also register your application with Bloomerang CRM to connect through OAuth.
This article explains how to generate API keys and why you might consider connecting through OAuth.
Generate New API Keys
Click the profile icon
. The icon shows the first letter of the username for the account.
Click My Profile.
In the API Keys 2.0 section, click Generate.
Enter a Name for this key in the Name field.
Click Generate.
Deactivate Existing API Keys
Deactivating an API key immediately renders it unusable.
Click the profile icon
Click My Profile.
In the API Keys v2.0 section, clear the Active checkbox.
Click Deactivate.
Deactivating a user account with active API keys also deactivates any keys.
API Keys Vs. OAuth
If you are building a server-to-server integration or making a one-off call to the REST API, using a private key is appropriate. Private keys are specific to each administrator user and can only be accessed while logged in to your own user account. Administrator users can generate multiple API keys if needed.
If you give a third party access to your data through the REST API, or you need to share your private key with somebody else, OAuth registration is a more secure solution. For information about OAuth registration for your application, read the Bloomerang OAuth Reference Guide.
View API v1.0 Keys
To view API keys that are in the older API v1.0 format, do the following:
Click Settings.
Click Integrations.
Click Integrated Partners.
Click Settings. The API v1.0 keys are listed in the API Keys v1.0 section of the Integration Settings page.