Generating and Revoking API Keys

To generate an API Key:

Clipboard to copy API Key

  1. Go to Grants page.

  2. Click the grant whose sub-contractor you want to generate a key for.

  3. Navigate to the sub-contracts page and open the specific sub-grant contract.

  4. In the sub-grant contract page, click ‘Generate API Key’. If an API Key had already been generated for the sub-grant contract, this button will not be visible.

  5. The API Key will be generated in the background and on success you will be notified in the UI. The generated API Key will be displayed in a modal window. Copy the API Key and store it securely, as it will not be displayed again.

  6. Share this API Key to your sub-contractor for use with the Grant Tenant Communication module to perform both scheduled donor reporting and budget lines submission.

Clipboard to copy API Key

To revoke an API Key:

Active API Key ready for revocation

  1. Go to Grants page.

  2. Click the grant whose sub-contractor you want to generate a key for.

  3. Navigate to the sub-contracts page and open the specific sub-grant contract.

  4. In the sub-grant contract page, click ‘Revoke API Key’. If an API Key had not been generated for the sub-grant contract, this button will not be visible.