How do I create an Interface Design Workflow API?

<Whatfix Walkthrough added here>

Adding an API

Illuminate has many ways to create APIs for use at your institution. In this instance, we will walk through creating an API using our Interface Design Workflow (IDW), which allows you to map and flow data between 2 existing APIs.  IDW can be started by clicking on the Interface Design Workflow button on the API Builder screen. This selection will move you to the start of the API construction process as shown below.

The General Details screen allows you to identify the API for use in the system. For simplicity, this screen is similar to the interface used in other types of API creation, although this API method is allowed to be either GET, POST, or PUT due to the nature of the API type. Unlike other APIs, the IDW does not use a code block to create the API, but instead requires the choice of two existing APIs. 

Once the general details have been filled in, the API builder requires you to choose a data consumer. Only APIs authorized for the same consumer can be mapped together in this process.. Once the consumer has been selected, the builder tool will expand to allow you to chose from the available consumer API’s as shown below.

As you select theAPI’s, the builder will expand again to display the source API variables on the right side of the screen, and the destination inputs below. At this time, source outputs can be mapped to destination inputs by either typing in the variable name, or by typing ‘:’ to open up a dropdown of the output variables and selecting one from the list.

Once the two API’s are mapped together as required, the output of the new IDW API can be selected below the mapping. There, output variables from either API can be checked for inclusion in the response.

A sample of the API response is displayed at the bottom of the interface.

Once the outputs have been selected, the API is finished. The API builder will then offer the option to set a job schedule for the API (which can be skipped at this time) from the bottom of the interface.