CivicPay Online Enhanced API Authentication

This feature enhances the security of communication between the CivicPay Online site and the associated Springbrook database. The API Key is essentially a password. Once the feature is activated, Springbrook and CivicPay Online will only accept messages from each other if the correct API Key is encoded into the message. This feature is available to clients whose Springbrook application is on version 7.15.0.0 or higher and whose CivicPay Online Organization is configured to use the V3 Interface.

Before you start:

Please review this entire document and confirm you have appropriate permissions to complete all the steps.

Enabling enhanced API authentication requires action to be taken in swift coordination by:

• A system administrator with full access to the Springbrook directory structure and the ability to recycle the IIS Application Pool on the server the CivicPay Online web service is hosted on.
• A CivicPay Online member with the role ‘Edit their organization’.

We recommend this activity be done outside of peak activity times for CivicPay Online as it is possible for there to be a brief service interruption. It is not possible to take the CivicPay Online site offline during this activity as CivicPay Online access is required to complete the procedure.

Your Springbrook application must be on a Service Pack requested after 04/14/17 in order to have the associated API changes and access to the tool used to perform this process.

Instructions for enabling or updating enhanced API authentication for CivicPay Online

Setting the API Key has three steps that must be done together:

1. Run the V7 API Key Tool to create a key and install it on the Springbrook server.
2. Restart the IIS app pool.
3. Enter the API Key on your CivicPay Online site.

The purpose of the V7 API Key Tool is to generate a unique API key for the UB Payments Web Service associated with a customer's specific Springbrook database "slot", and to update the WCF bindings in the Web Service's config files. The tool should be run by a system administrator with full access to the Springbrook directory structure. It can be run against 7.15.0.0 and higher Springbrook installations.

Before you run the tool:

1. Login to your CivicPay Online site. You will need to enter the new key once it is created. Instructions are below.
2. Open IIS Manager. You will need to recycle the IIS app pool. Instructions are below.

Run the V7 API Key Tool

1. Install the latest Springbrook service pack.
2. Locate the V7ApiKeyToo.exe. It is found in the Springbrook build/service pack Misc folder. This folder is most likely found at C:\Springbrook\Springbrook0.
3. Copy V7ApiKeyToo.exe to the machine that is hosting the Springbrook server-side application.
4. Run the V7ApiKeyToo.exe tool.
5. Supply the appropriate Slot Directory, e.g. C:\Springbrook\Springbrook5.
6. Click the Run button. When the tool completes successfully, the API Key text box will display the newly generated API key.
7. To obtain the API Key either click Copy to Clipboard or Export Log.

Recycle IIS

1. At Administrative Tools, open IIS Manager.
2. In the Connections Pane, click Application Pools.
3. In the center pane, right-click on the application pool associated with the webservice. This is most likely named SpringbrookV7.
4. Click Recycle.

Enter API Key in CivcPay Online

Before you start you must update the API Key on your organization. In order to make this update, you must login as a member with the role ‘Edit their organization’.

1. Go to the CivicPay Online site.
2. Login as an admin member with the role ‘Edit their organization’.
3. Go to the API Key tab under My Agency > Settings.

4. Paste the API Key into the API Key field.
5. Click the Save button to save the API key settings.