Technical overview
The Whereis® API can be integrated as a component into your existing or new application. Most developers access the Whereis® API from their server side web-based application using our JavaScript API. You can also put the Whereis® API functionality into a standalone application via our SOAP interface as long as it has network access (so it can reach the geospatial platform within the Sensis network).
How does it work?
- Your application receives a query from the end user (e.g. a request for a street address)
- Your application makes a request to the Whereis® API
- Your application receives a response from the API before formatting and presenting the result to the end user
The Whereis® API is available in two different forms.
1. JavaScript API
The Whereis® JavaScript API is designed for browser-based applications that are both simple and flexible to use. It's simple because you can put a fully dynamic and interactive map on a webpage with only a few lines of code; and flexible because this API is built on, and extends, OpenLayers, a popular and well-supported open-source mapping API. The tiling and caching technologies implemented by the JavaScript API facilitate a seamless, fast, and easy-to-use mapping experience for the user.
2. SOAP API
The Whereis® SOAP API is designed for more complex applications or applications that require something other than a web browser (e.g. a Flash application). The SOAP API provides a WSDL file that implements the industry-standard OpenLS specification for location-based services (refer to www.openls.org).
Using this method, you can construct and populate a request object with various parameters, then send it to the server. The reply from the server contains the response object you need.
| Feature | Javascript | Soap |
| Display an interactive map in HTML element (includes zoom, pan and map/photo view controls) |  |
 |
| Get a map as an image for printing (includes route, map makers, etc.) | |
|
| Add markers to map | |
|
| Display hover boxes or information windows to markers on the map | |
|
| Route between two locations (includes map display and turn-by-turn instructions) | |
|
| Route between two locations including multiple via or way points | |
|
| Geo-coding (includes exact and partial match suggestions) | |
|
| Reverse geo-coding | |
|
| Rank a set of points by proximity (via street network and straight-line) | |
|
| Search thousands of UBD points of interest nationwide | |
|
How to register
To register for developer access to the Whereis® API please contact us.
Why Whereis®?
Discover why you can rely on us to get you where you want to go. Why Whereis® maps are spot on.
Update your maps
Find out how to update your maps with the latest Whereis® data.
More information
For more information about any of the Whereis® products and services please email or call our customer service centre on 1800 819 471