How do I create an API with a file as a source?

<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 how to create an API using our File As Source tool, which can be started by clicking on the corresponding 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 section allows you to identify the API for use in the system. For simplicity, this screen is similar to the interface used for other types of API creation, although this API method is allowed to be either GET, POST, or PUT due to the nature of this API type. Unlike standard APIs, File as Source does not use a code block to create the API, but instead requires a connection to a file on your server.

Similarly to setting up a connection, you will need to specify server and authentication details as well as an encryption key, if encryption is required. Additionally, the FTP Directory requires both the folder pathway and the filename to be specified in order to find the correct file.

Once the file is specified, the response variables will need to be entered. This can either be done manually, via an uploaded file, or by copying in a code block of the expected output. 

Note: if you input response variables by pasting in a code block with data values, those values will be set as the default output of the API. 

After the response variables are set, select ‘Next’ to save the API and move on to dynamic filtering and data rules.

Dynamic filtering allows the API to screen the output based on specific variable values. This is done by either copying in a custom filtering expression, or by using the Illuminate Dynamic Filter to specify out variables, a relationship with a value, and an AND, OR, or NOT connection to other variables. Illuminate will then only include output data sets that match the chosen filter. 

Note: this process can be done both before and after the data rules and translations are set, but both are optional.

The data rules and translation portion of the API builder allows further customization of the API and can help facilitate the interaction between two different pieces of software that have different input and output parameter names. This is done by allowing an alternate parameter name that the API will report in its output. Once all expected output variables have been marked to be included in the response, as well as any translations and masking added,  click Nextto move on.

By now, if the API has been correctly set up, a checkmark should have appeared next to both API Definition and Data Rules & Translations in the progress bar as well as on the pre and post dynamic filtering if those options were used. If it hasn't, those portions can be selected to move back to those sections for editing.

Finally, confirm the output format for the API by comparing the format from the dropdown with sample output below it, and then select which data consumers will have the API enabled by default in the consumer screen which is displayed if you have multiple consumers.