API Name: places-delivery-api

Introduction

AfriGIS Delivery Address Formatting (places-delivery-api) returns an address broken down into separate address lines based on results obtained from AfriGIS address datasets. The purpose of this API is to assist in generating physical and postal address details for the use in service or product delivery.

Overview

Client applications provide input via an SEOID into the Delivery Address Formatting API. The SEOID can be obtained using AfriGIS Autocomplete API or AfriGIS Geocode API. On executing the call, the address is returned in a line-by-line format suitable for physical or postal deliveries.

Depending on the feature SEOID passed into the call, the response will populate the relevant levels of the address lines. This could mean that some address lines will return a null response. For example, if the feature SEOID is for a Province (administrative_area_level_1), the address lines 1-5 will provide a null response. In an example where the SEOID for a street number and name (street_address_level_1) is entered into the call, the result will populate all address lines except address line 2, the Province and the Country.

View Address types

Part of the response include AfriGIS confidence levels. These are an indication of the level of accuracy to which an address has been located.

Confidence levels

Authentication

This API makes use of OAuth2 authentication. To integrate, sign up for a free trial account by contacting [email protected]

For detailed integration instructions using OAuth2, please click on the following link: https://developers.afrigis.co.za/oauth2-authentication/

To view technical documentation describing the details of places-delivery-api, click on the button below.