Get Started with API Integration

The Settings > API Configuration area is used to configure and integrate external APIs to load form field custom data and connect to the GrantsConnect API with the purpose of retrieving and updating data.

Key Features

  • Build integrations to retrieve data from GrantsConnect

  • Utilize integrations to update and create data within the system

  • Access payments, Grant Manager users, workflows, and workflow levels, and detailed data outside the system

  • Integrate external API form fields to call your web services and respond based on your custom configuration

 

Learn More

Note: For more information, see the API Configuration resources.

GrantsConnect offers multiple ways to integrate data with external API systems. This includes both the standard GrantsConnect API and custom external APIs configured by the client.

The external API functionality allows clients to call their own Rest APIs to accomplish tasks like verifying an Applicant's eligibility for a program or pre-populating fields on a form.

  1. Configure your API web services.

  2. Create External API form fields to call these services and respond appropriately based on their configuration.

  3. Add External API fields to forms that will be used in the application process.

  4. Configure External API fields in forms to define the field's actions and responses.

Note: For more information, see the API Configuration > External API resources.

The GrantsConnect API allows organizations to build integrations to retrieve data from GrantsConnect as well as update and create data within the system. This can be used to retrieve and update payments, Grant Manager users, workflows, workflow levels, and detailed data.

  1. Get started with the GrantsConnect API by getting an API key, using Postman to interrogate APIs, and setting up your GrantsConnect UAT environment.

  2. Configure your API web services.

  3. Manage users using the GrantsConnect API.

  4. Manage workflows using the GrantsConnect API.

Note: For more information, see the API Configuration > GrantsConnect API resources.