getAddress.io

The getAddress.io API is a service for finding UK postal addresses based on the postcode entered. You can also find the distance in meters between two postcodes.

For more information on getAddress.io see the company website.

In the context of Nintex Workflow Cloud, getAddress.io is a connector Service used to define a connection required for associated actions and start events. Examples include Salesforce and Box. Method of integration to cloud services, business applications and content stores..

The getAddress.io connector Service used to define a connection required for associated actions and start events. Examples include Salesforce and Box. Method of integration to cloud services, business applications and content stores. is used to create connections for getAddress.io actions A tool for building the processes, logic, and direction within workflows..

The following actions are available:

  • Find address
  • Get addresses by post code
  • Get distance

The getAddress.io connector can be used to list the businesses within a post code for marketing purposes.

Use the Find address action in a workflow to retrieve details about an address. Use the Get addresses by post code action to retrieve a list of addresses at a postcode. Use the Get distance action to retrieve the distance in meters between two post codes.

Create a getAddress.io connection

You can create connections from the Automate or Designer page.

  • The account you use to create a connection for getAddress.io is the account that has access to the getAddress.io actions.

  • You need an API key to create a connection. Get an API key based on your plan (free or paid) from the getAddress.io website.

  1. On the top navigation bar, click Automate, and then select Connections from the left navigation.

  2. On the Connections page, click Add new.

  3. In the Add a new connection section that opens, fill in the following.

    In this field

    Select or enter the following
    Connector getAddress.io

  4. Click Connect.

  5. In the Configure a connection window, fill in the fields as follows.

    In this field

    Select or enter the following
    Connection name A name for your new connection.
    API Key An access key generated by the getAddress.io site specific to your email address/account.

  6. Click Connect.

  7. If prompted, enter credentials and grant access to Nintex Workflow Cloud.

  8. In the permissions dialog, you can do one of the following:
    • Edit the Owners or Users permissions according to data source usage requirements and click Save permissions.

      • Tip: You can assign connection owners or users permissions according to your access requirements. For more information, see Permissions.

Your new connection appears on the Connections page.

    • On the top navigation bar, click Automate > Workflows, and then select the required workflow.

      • (Or)

    • On the top navigation bar, click Automate > Create workflow.
  2. Click the getAddress.io action you want to add the connection to, or drag a getAddress.io action into the workflow and select it.

  3. In the drop-down list for Connection, select Add new connection.

  4. In the Connection window, fill in the fields as follows.

    In this field

    Select or enter the following
    Connection name A name for your new connection.
    API Key An access key generated by the getAddress.io site specific to your email address/account.

  5. Click Connect.

  6. If prompted, enter credentials and grant access to Nintex Workflow Cloud.

  7. In the permissions dialog, you can do one of the following:
    • Edit the Owners or Users permissions according to data source usage requirements and click Save permissions.

      • Tip: You can assign connection owners or users permissions according to your access requirements. For more information, see Permissions.

Your new connection appears in the Connection field of your action.

Permissions

Permissions enable you to manage access for other users to use, edit, and delete connections.

  Use

Edit

 Delete

Assign
permissions

Owners
Users

Note: By default, users with administrator role will have the same rights as a Connection owner.

Follow these steps to assign permissions from the Connections page:

  1. On the Connections page, click for the required connection.
  2. From the menu, select Permissions.

    3. The corresponding permissions window is displayed.

  3. To assign permissions:
    • In the Owners field, type the name of the user, and select from the list.
    • In the Users field, type the name of the user, and select from the list.
  1. Click Save permissions.