Installation & Setup

Install the SDK, activate it with your license key, and get oriented in the examples that ship with the package.

License key file

The SDK is activated with a license key file, firstlogic.key, provided by Firstlogic. Place it in your installation folder and point the configuration at that folder with the Keyfile_Folder setting. The engine reads the key on startup to enable processing.

Minimal key + data configuration
{
  "Address_IQ_Configuration": {
    "Keyfile_Folder": "/opt/AddressIQ",
    "Supporting_Data_Folder": "/opt/AddressIQ/data"
  }
}
Note: The engine also needs its supporting reference data. Point Supporting_Data_Folder at the installed data directory, and set the CASS/geocoding data folders in their respective option groups (see Configuration).

Installation layout

A typical installation contains everything you need to build against the engine in any supported language:

  • Language subfolders — separate folders for C++, Java, and .NET, each with native HTML API documentation and runnable code samples.
  • Examples — a top-level folder of JSON and XML examples covering configurations, inputs, outputs, and errors.
  • Supporting data — the reference data the engine loads at runtime.
  • SDK link directory — a folder of shared resources the engine references; if you relocate it in a distributed application, keep its contents together and update the corresponding path in your configuration.

Examples & samples

The SDK is designed to be learned from its examples, and they double as the most reliable field reference:

  • Configuration examples — starting points named for their scenario (for example, a discrete-input U.S. configuration), which you copy and adapt.
  • Input examples — the expected structure and field names for discrete, hybrid, and multiline input.
  • Output examples — the structure of returned records; each output example contains the full list of possible output fields, making it the best reference for what the engine can return.
  • Code samples — small, runnable programs in each language, each with a Readme that walks you through getting up and running.
Tip: Because the set of available fields evolves between releases, prefer the output examples in your installation as the source of truth for exact field names, rather than any static list.

Your first integration

At a high level, integrating the SDK follows the same shape in every language:

  1. Start from a shipped configuration example that matches your country and input style.
  2. Set your key, data, and SDK paths in that configuration.
  3. Initialize the engine with the configuration.
  4. Submit records and read the structured results.
  5. Shut the engine down cleanly when finished.

The Processing Model page describes this lifecycle in more detail, including threading.

PreviousIntroductionNext Configuration