Home

This documentation is for developers integrating the AddressIT API address search and matching capabilities into a front end web based form.

AddressIT API functions are provided via REST APIs, with documentation for each function provided as Swagger Docs

Continue with the links below for information and examples on how the APIs should be integrated into a front end web page. This guide will mainly contain examples for implementation using React and JavaScript, however the general theory can be applied to any front end/client side language that can do REST API calls.

Note that there is a live React based demonstration of this functionality found in the AddressIT Customer Portal. Sign up or sign in with any account to try it.

ISW (the creators of AddressIT) are happy to assist with any front end integration of our API. Contact us at amas@isw.net.au

Step One

Address Search/Lookup field - perform a search using user input and present the returned suggestions as a selectable list.

Step Two

Process the selected address to receive its individual address components.

Step Three (optional)

Parse a user entered address string into its separate components when the desired address can't be found in the search suggestions. Then using the returned address components for manual address entry