Technical Document

What is an API?

What API libraries does QAS supply?

Should I use the High Level (UI) or Primary API (low level)?

What is the Compatibility API?

What's new with the Pro v4 API?

What is the best way of integrating API products?

How do I test whether an API is installed correctly?

How do I establish why an API integration isn't running?

What is kernel logging and how do I use it?

How do I find out the product version/location of data files/data vintage I'm using?

What is an API?

It stands for Application Program Interface. Designed to be integrated into databases or applications, this provides an extremely versatile way to include address management functionality.

What API libraries does QAS supply?

QAS typically supply several types of libraries – one on Windows and two on UNIX (two most common platforms).

Windows: The library files on Windows are known as DLL (dynamic link libraries) and can be used in any Microsoft environment. Any number of applications can access a DLL file.

UNIX: There are two types of library file available; ‘.a’ files and ‘.so’ files. ‘.a’ files are known as static libraries and only one application can use a ‘.a’ file. ‘.so’ files are known as shared object libraries and are a UNIX equivalent of Windows DLL files.

Other libraries are available, please contact support for more information.

Should I use the High Level (UI) or Primary API (low level)?

The Windows version of the Pro API is available with a User Interface (UI) that has been carefully designed to allow users to search for addresses in a simple, fast and intuitive manner. Using this interface is the simplest way to offer these benefits, as much of the programming (such as the picklists) has already been done.

However, though the UI utilises the latest Windows controls and layouts, it may not fit the look and feel of the application. For this reason a comprehensive set of functions is also provided to allow a UI to be created in the style of the target application. These functions incorporate the entire functionality provided as standard by the QuickAddress User Interface. If the target platform is not Windows based, a UI must be created.

The collection of these lower level functions are referred to as the low-level or Primary API.

What is the Compatibility API?

The QuickAddress v4 Compatibility API allows customers with existing QuickAddress World v3 API integrations to upgrade to the latest version of QuickAddress v4 products simply.

Basically, It allows the use of code from a QuickAddress World v3 Low Level integration with the QuickAddress v4 product library. As the Compatibility API is made using the v4 architecture many of the new features (e.g. improved picklist handling) will be seen without coding alterations. However, within the v4 architecture errors may be handled differently so it is advised that customer update their integration to handle the new errors, including those related to licensing. The compatibility API does not allow the use of Names or Business Data, but DataPlus sets can be used.

What's new with the Pro v4 API?

The key new features of the Pro v4 API are as follows:

One search function. (The two search modes Typedown and Single Line are now accessible via one function call making it even easier to swap between the two).

Merged Typedown modes. (Three different integrations are no longer required for street, organization and PO Box modes).

Improved error handling.

Much more information about the search available. (It is possible to see if a search has been started, whether it is still in progress or if it has timed out. Also there is further information about the returned results, for example if there has been a postcode recode for that property).

Asynchronous searching. (Allows implementation of a “cancel search” button).

What is the best way of integrating API products?

QAS supplies extensive sample code for all its products to help developers integrate QuickAddress products easily and swiftly. The programming languages supplied by default are C and Visual Basic.

Sample code should be seen as the starting point for an integration, and should be tailored according to the type of integration that you are performing. Sample code is used to demonstrate best practice and includes the features likely to be required by a majority of users. Download Sample code.

If you require sample code for a programming language other than those listed please contact support to see whether it is available or not.

Pro API developers additionally benefit from the ideal implementation document. This helps developers integrate the API in best method suitable to themselves.

How do I test whether an API is installed correctly?

Use the supplied test harness. Each QuickAddress API has its own test harness. The Pro Primary (low level) and High Level API have their own test harnesses. Consult your respective QuickAddress product manual for more information.

How do I establish why an API integration isn't running?

To ascertain why an integration may not be working you can produce logs on the inner workings of the API. Please consult the document How to solve problems with QuickAddress API integrations to find out how this is done.

What is kernel logging and how do I use it?

Please consult the document How to solve problems with QuickAddress API integrations for more information.

How do I find out the product version/location of data files/data vintage I'm using?

If you are using any of the following implementations on any Windows platform this is straight forward:

• Pro Plug & Go
• Pro UI (High Level) API
• Pro Configuration Editor
• Pro Server/Client
• Batch Standalone

Use the hotkey combination displayed below with your QuickAddress product maximised and in focus (i.e. the main application being used on you desktop).

Within the Product Information window you will be able to locate your release version/location of data files and/or data vintage.

In fact any product where you can reach the QuickAddress User Interface (UI) you can easily ascertain your product version.

For all other platforms and a screenshot please consult the following document: How to access the QuickAddress System Information Dialog Box.

For all other v4 implementations:

• Pro Primary API (low level)
• Batch API

This information can be found as follows:

Version: This can be found for any product within the product revision file (QABWVED.REV - Batch API, and QAUPIED.REV - Pro Primary API). Open file in a non-formatting text editor and the product version is listed at the top of the file, e.g. QABWVED 4.02.

Data Location: This can be found for any product within the QAWSERVE.INI file. Open file in a non-formatting text editor and look for the AllInstalledCountries keyword. Each installed country database will have its own specified data location under this keyword. For example: AllInstalledCountries=AUS,Australia,C:\Program Files\QAS\Data\Aus.001\aus.