Skip to content
English
Contact Support
  • There are no suggestions because the search field is empty.

API Integration

Learn about the API Integration with Foundry.

With data as a key decision-driver, having automated integrations is key to a seamless experience for organizations. EVERFI’s Public API (Application Programming Interface) for Foundry empowers organizations to build applications or leverage existing applications to send and receive valuable data and insights, saving time and deepening their understanding and management of system learners.

With EVERFI support, customers will receive expert insights on how to create and build a system that works best for their needs.*

*Note: At this time, EVERFI does not have out of the box APIs, but customers may build an API based on their requirements or EVERFI can suggest partners with whom you may work to contract out the API build.

EVERFI's Foundry API

The API allows organizations to maximize the value of Foundry and take deeper steps to know their users and keep things current by:

  • Integrating third-party systems like HRIS and CRM 
  • Managing users by adding, updating, deactivating and reactivating
  • Retrieving users’ progress and learning activity
  • Grouping learners with common attributes such as location, category and labels to streamline assignments

Data Automation Benefits

Enabling the Foundry API improves efficiency by: 

  • Automating data transferred between Foundry and other key systems
  • Leveraging data from Foundry and other systems to create a “best-in-class” data ecosystem
  • Eliminating manual processes and the potential for error 
  • Strengthening the impact of Foundry and paired key enterprise-level systems

How it Works

Organizations will first make a secure POST and/or GET call via an SSL encrypted HTTP request. The service is protected by OAuth 2.0 using the client credentials grant workflow. The system that connects to the Foundry API must be able to send and receive HTTP web requests and responses using the JSON format.

1. Administrators will log into Foundry, click on “Settings” and then “Data Integration.” This will register an Application for the API.

2. A client ID and client secret will be generated. Click the copy button to copy the values to use in the application.

3. Using the OAuth2.0, client credentials grant workflow to use the client ID and client secret to get the access token.

4. Use the Program User Data API calls to retrieve data about users’ participation and course progress.

Note: To stop and invite from being sent to newly added learners - In the JSON properties you can include an "is_invited" attribute and set it to "false". This will disable sending the email invitation.

How it is Set Up

In order to implement the API, the IT department will need to be familiar with REST.  It’s important to get them involved in this initiative early to ensure successful implementation. System, resource availability, and complexity of desired data points will impact the timeline for implementation.

The Process:

1. EVERFI will turn on the API capability in Foundry.

2. EVERFI will provide the organization with documentation on how to access and configure. 

3. Your IT team will begin the application build to connect the API to your system/application.

4. Your IT team will test the API Once the data is retrieved, your IT team will review it and provide feedback to EVERFI’s implementation team.

 

Detailed API Documentation

The EverFi API Postman Collection contains templates, detailed documentation and sample requests; everything you need to set up your API integration on Foundry. To download this collection so you can run it locally in your Postman desktop app, do the following steps.*

1. Open your Postman desktop app

2. In Postman, select the Workspace into which you want to add the EVERFI API Collection

3. In your browser, navigate to the EverFi API Postman Collection (link above)

4. Click the Run in Postman link on the upper right

5. In the Run in… window that opens, choose the Postman for Mac or Postman for Windows link as appropriate

6. The Collection will be downloaded into the open Workspace, so go to your Postman app and you should see the newly imported Collection

Note: Updated November 2020. Postman may change these instructions in the future; please contact us for any edits.