# Prerequisites

## License Criterion 

To access the [Find](https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup#find) or [Business Validation](https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/business-validation) API, you must meet the following prerequisites:

1. **Harmony License Key:** Obtain a valid Harmony license key from our support team.
2. **Business Data:** 

   * Ensure you have access to valid business data associated with an active license key.
   * Make sure to copy the business data to the base location specified in the hello.properties file as detailed in the section below.

## Business Data Configuration File

The configuration file hello.properties is available in $HARMONY\_HOME/config folder. 

This file details dedicated base folder location for Business Data, folders to be configured to store the recently downloaded Business Data updates and the folder to store the latest updated Business Data. Below are the details to configure.

Please ensure you have required access permissions on these folders.

{% hint style="info" %}
**Note:** 

Any changes to this file will require restart of Business App detailed in [Getting Started](#getting-started-with-business-lookup-app-to-access-find-api).\
Similarly changes to this file will also require restart of the application server and harmony HSQL database as detailed in [Getting Started](#getting-started-with-business-validation).
{% endhint %}

**BASE location prefix for Business API Index Data**

By default, this property will read business data from $HARMONY\_HOME/ROAD e.g. $HARMONY\_HOME/ROAD/HELLO\_BUSINESS\_AU or $HARMONY\_HOME/ROAD/HELLO\_BUSINESS\_NZ.

If you wish to designate a custom folder location, configure the property in the hello.properties, refer the sample below.

```properties
harmony.hello.business.location.base = C:/ROAD_2/HELLO_BUSINESS_AU
```

**Latest location prefix for new Business API Index Data**

By default, this property will read updated business data from $HARMONY\_HOME/ROAD/LATEST e.g. $HARMONY\_HOME/ROAD/LATEST/HELLO\_BUSINESS\_AU or $HARMONY\_HOME/ROAD/LATEST/HELLO\_BUSINESS\_NZ.

If you wish to designate a custom folder location, configure the property in the hello.properties, refer the sample below.

```properties
harmony.hello.business.location.latest = C:/ROAD_2/UPDATED/HELLO_BUSINESS_AU
```

**Download location prefix for the Business API Index Data going to be updated.**

By default, this property will read business data from $HARMONY\_HOME/ROAD/DOWNLOAD e.g. $HARMONY\_HOME/ROAD/DOWNLOAD/HELLO\_BUSINESS\_AU or $HARMONY\_HOME/ROAD/DOWNLOAD/HELLO\_BUSINESS\_NZ.

If you wish to designate a custom folder location, configure the property in the hello.properties, refer the sample below.

```properties
harmony.hello.business.location.download = C:/ROAD_2/DOWNLOAD/HELLO_BUSINESS_AU
```

**configure reload api key to grab the new business data update available in "business.location.download" and update the designated "business.location.latest" folder.**

Replace 'YOUR\_RELOAD\_API\_KEY' with actual API Key designated for reload operations. 

```properties
harmony.hello.business.reload.key=YOUR_RELOAD_API_KEY
```

## Getting Started with Business Lookup APP to access Find API

Follow these steps to launch the [Business Lookup](https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/business-lookup) APP:

Launch a terminal or command prompt within the $HARMONY\_HOME directory where the harmony-business-app.jar is located, and run the provided command:

**Launch Business App on default port (18080)**

```bash
java -jar harmony-business-app.jar
```

**Launch Business App on Custom Port**

Run the following command, replacing `CUSTOM_PORT_NUMBER` with your desired port:

<pre class="language-bash"><code class="lang-bash"><strong>java -jar -Dserver.port=CUSTOM_PORT_NUMBER harmony-business-app.jar
</strong></code></pre>

## Getting Started with Business Validation

Follow these steps to process the [Business Validation](https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/business-validation).

start-up Application server (Tomcat)

From Start menu, Search for **Harmony** and then start up HSQL database by clicking **Start Harmony Database**

<figure><img src="https://2735524619-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fhp3nSGDGzW6K0AYaMW45%2Fuploads%2Fm11ojnRdTZkDy7jCmORz%2Fimage.png?alt=media&#x26;token=c7d4ebe1-f2ea-4386-85a8-8176deaa39d9" alt=""><figcaption></figcaption></figure>

## API Access Details

Once the [Business Lookup](https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/business-lookup) API is running, you can access it using the appropriate endpoints, authentication, and parameters. Refer to the [Business lookup ](https://docs.mastersoftgroup.com/harmony-suite/user-guides/version-3.0.0/business-lookup-and-validation/business-lookup)for detailed information on available endpoints, request formats, and response structures.

## Support and Assistance

If you encounter any issues or have questions about accessing the Business API, feel free to reach out to our support team at \[<Customer.Support@gbgplc.com>].

Thank you for choosing our Business API. We look forward to assisting you in integrating seamlessly with our services!

##