What is an Application Program Interface (API)?

An Application Program Interface (API) is a set of procedures and tools used to create a software program. Through the Foundry API, you can manage users (add, update, deactivate and re-activate), locations, categories and labels, and retrieve users’ learning progress and program activity.

Why it Matters

The API allows data and information to be shared seamlessly between a course platform and course applications. While not required, if integrated, it requires less manual work from IT Administrators because established protocols are used and less time is needed to discover and create programming for a course and its features to work together.

Implementation

If you want to use the API, there are implementation steps required to integrate the interface.

API Documentation and Postman Collection – Provides templates, documentation and sample requests: EverFi API Postman Collection

To download this collection so you can run it locally in your Postman desktop app, do the following steps. Note that these instructions are accurate as of November 2020 but Postman may change these in the future. If you notice. mistakes, please contact us.

  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

Workday Studio

If you are connecting Workday Studio to the Foundry API, download this CLAR file developed by an EVERFI partner for pointers. This is a starter template, not a complete solution, that illustrates authentication, token management, and a simple GET request. You will need to implement your own logic specific to your organization and your needs.