Private API keys are handled at the user level in the database, and can be generated in order to set up a new integration with Bloomerang using the REST API. You can also register your application with Bloomerang to connect via OAuth. This help article includes steps for creating API keys in User Settings, and additional information about why you might consider connecting via OAuth.

  1. Generate New API Keys
  2. Deactivate Existing API Keys
  3. API Keys Vs. OAuth

Generate New API Keys

  1. Click Profile icon
  2. Click Edit My User.
  3. In the API Keys section, click Generate.

  4. Enter a Name for this key in the Name field.
  5. Click Generate.


Deactivate Existing API Keys

Deactivating an API key immediately renders it unusable. 

  1. Click Profile icon
  2. Click Edit My User.
  3. In the API Keys section, un-check Active.
  4. Click Deactivate

Deactivating a User Account with active API keys will also deactivate 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 are allowing a third party access to your data via the REST API, or you are otherwise in a position where you might need to share your private key with somebody else, OAuth registration is a more secure solution. See steps for OAuth registration of your application here.


Related

  1. Bloomerang API Documentation
  2. Bloomerang REST API
  3. Bloomerang OAuth Reference Guide