Configure

Api2File has two main configuration files. AppSettings and Apis. Both files can be easily modified using a text editor of your choice.

AppSettings

The AppSettings file is used to alter the way in which Api2File runs; By, for example, changing the directory that the license files are loaded from.

AppSettings is shipped with sensible defaults, meaning you should not need to alter the file to get Api2File up and running. If you do want to modify it, AppSettings.json is located in the root of the installation directory.

Apis

The Apis configuration file defines what Api2File does when it runs. The file contains the information on the APIs to use to source data, how to connect to them and how to modify the data they provide.

The Apis file is shipped with an example configuration that will run out of the box and provides a basis from which to configure your own Apis.

The default filename for the Apis configuration file is apis.yaml, located within the root of the installation directory. This location and filename can be overridden in the AppSettings file.

< Previous topic
Api2File Installation
 
Next topic >
Configure APIs