Application Configuration File

• The Flight Recorder REST API and Flight Recorder Manager command line tool use similar application configuration files, with common settings as indicated below

General Settings and Database Connection String

Section	Key	Applies To	Purpose
ApplicationSettings	LogFile	Both	Path and name of the log file. If this is blank, no log file is created
ApplicationSettings	MinimumLogLevel	Both	Minimum message severity to log (Debug, Info, Warning or Error)
ApplicationSettings	SightingsExportPath	API	Path to the folder where sightings exports are written
ApplicationSettings	AirportsExportPath	API	Path to the folder where airport IATA code exports are written
ApplicationSettings	ReportsExportPath	API	Path to the folder where report exports are written
ApplicationSettings	ApiEndpoints	Both	Set of endpoint definitions for external APIs
ApplicationSettings	ApiServiceKeys	Both	Set of API key definitions for external APIs
ConnectionStrings	FlightRecorderDB	Both	SQLite connection string for the database

External API Configuration

• The command line tool and web service include integration with the AeroDataBox public API for flight, airport and aircraft details lookup:

AeroDataBox

• To use the integration, a RapidAPI subscription is needed, as this includes an API key needed to acces the APIs
• Signup is free, but daily free usage is restricted with a nominal charge being made for requests above the free limit
• The integration is configured via the following keys in the configuration file:

Section	Sub-Section	Purpose
ApplicationSettings	ApiEndpoints	A list of endpoint definitions, each containing the endpoint type, service and endpoint URL
ApplicationSettings	ApiServiceKeys	A list of entries mapping each service to the API key needed to access that service

ApiEndpoint Definitions

• An example API endpoint definition is shown below:

{
  "EndpointType": "Flight",
  "Service": "AeroDataBox",
  "Url": "https://aerodatabox.p.rapidapi.com/flights/number/"
}

• Possible values for the endpoint type are:

Type	Description
Flight	Endpoint used to retrieve flight details given a flight number and, optionally, a date
Airport	Endpoint used to retrieve airport details given an airport IATA code
Aircraft	Endpoint used to retrieve aircraft details given an aircraft registration number or 24-bit ICAO address