Set Up GrantsConnect API

Note: The instructions for configuring the GrantsConnect API may differ from setting up external APIs.

To utilize the GrantsConnect API, an Administrator must set up an API key from the GrantsConnect user interface.

  1. Navigate to the Settings > API Configuration > GrantsConnect APIs area.

  2. Select the Add GrantsConnect API button.

  3. In the Add GrantsConnect API screen, provide the following information.

    1. Specify a name.

    2. Setup the token expiration.

      Tip: For security reasons, it is recommended to set the expiration to one (1) year.

    3. Set the appropriate permissions by selecting Read and/or Write for each service (e.g., Batches, Grant Manager Users, Invitations, etc.).

      Note: For more information, see the Configure API Web Services resource.

After these settings have been saved and the API key generated, Administrators should save the key for their records.

Warning: They API key cannot be retrieved after exiting the Add GrantsConnect API > Key screen. If the key is lost, a new one will have to be created.

Tip: For security reasons, Blackbaud recommends creating a new API key annually. Learn more.

Postman can be used to manually interrogate the GrantsConnect API to better understand what it does, how it works, and what is returned.

  1. Set up Postman Workspace.

    1. Download Postman at https://postman.com.

    2. From Postman, select File > Import and upload the workspace.

  2. Input the API key into the workspace.

    1. Select the API of interest (e.g., Get User Roles).

    2. Select the Headers tab in the center of the interface.

    3. From the Headers tab, input the API key in the Value field along with the Key name x-bb-Key.

      Warning: The Key name (i.e., x-bb-Key) is case sensitive. If input incorrectly, an error may occur when connecting.

    4. Select the Send button.

  3. At the bottom of the interface, select the Body tab and then Pretty to return the API endpoints. This will display the JSON response from the API.

    Note: Detailed documentation for GrantsConnect API endpoints can be found here.

It is recommended to use the UAT environment to first build and test API interfaces before enabling them in the Production environment.

Note: Detailed documentation for GrantsConnect API endpoints can be found here.