Settings

Introduction

Once the Autoaddress control is initialised, you can pass in several settings to customize your experience.

There are two settings which are the minimum requirements to be used in your control these are elementId and your authentication method which can be either apiKey or token.

Setup

The below code snippets demonstrates how to initialise the Autoaddress control with the two different authentication approaches.

In this code for the apiKey approach:

Autoaddress is an object representing the Autoaddress plugin, and you initialize it with configuration options.

elementId  specifies the ID of the HTML element where the Autoaddress plugin will be rendered.

apiKey should be replaced with your actual API key from the Account Center.

<script type="text/javascript">  
var aa = Autoaddress({
  apiKey: "YOUR_KEY",
  elementId: "aa-control", 
});
</script>

or

Similarly for initialising the control with the token approach you simply replace the apiKey property with the token property.  You should never add both properties. To retrieve a token, please see our createToken API documentation. 

<script type="text/javascript">  
var aa = Autoaddress({
  token: "YOUR_TOKEN",
  elementId: "aa-control", 
});
</script>

Setting options

Below you will find several configuration settings that are currently available for use on the Javascript control.

<script type="text/javascript">  
var aa = Autoaddress({
  apiKey: "YOUR_KEY",
  elementId: "aa-control", 
  // Sample usage of setting additional settings on the control
  // Set language 
  language: "en",
  // Set country bias
  country: "IE",
  // Turn off form validation (Only used in AutoaddressForm integration type)
  validateOnChange: false,
  // Change integration type - default is "AutoaddressForm"
  integrationType: "CustomerFormInline",
  // Add callback to capture address result
  onAddressResult: function (result) {
     // Parse address from result and populate your own form.
     // Result will you give you access to the full Lookup API response.
  }
});
</script>

Note: * indicates that this is Required