Prerequisites
A comprehensive guide that signifies the essential requirements that needs to be met to access Business Lookup and Validation. Before you begin, please follow the steps outlined below.
License Criterion
To access the Find or Business Validation API, you must meet the following prerequisites:
Harmony License Key: Obtain a valid Harmony license key from our support team.
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.
Note:
Any changes to this file will require restart of Business App detailed in Getting Started. Similarly changes to this file will also require restart of the application server and harmony HSQL database as detailed in Getting Started.
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.
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.
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.
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.
Getting Started with Business Lookup APP to access Find API
Follow these steps to launch the 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)
Launch Business App on Custom Port
Run the following command, replacing CUSTOM_PORT_NUMBER with your desired port:
Getting Started with Business Validation
Follow these steps to process the Business Validation.
start-up Application server (Tomcat)
From Start menu, Search for Harmony and then start up HSQL database by clicking Start Harmony Database
API Access Details
Once the Business Lookup API is running, you can access it using the appropriate endpoints, authentication, and parameters. Refer to the 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!
Last updated
