Ordnance Survey User Guide

How to setup the Ordnance Survey Integration in Colleague.

UK Postcode Lookup

Colleague can integrate with Ordnance Survey (UK) to provide an address lookup based on the entered Postcode.

When enabled, on all the address forms throughout the system, a User can enter a postcode and then click on a magnify glass to lookup and select the associated addresses. The selected address will then auto-populate the address fields.

Pricing

Ordnance Survey will charge for access to their API based on a premium plan (osdatahub.os.uk/plans).

Colleague uses the 'OS Places API'. This is available free of charge under a 60 day trial, after which Ordnance Survey will charge your account £0.01 per address lookup.

Setup

To setup the integration, go to this website: osdatahub.os.uk

Register an Account

Select the 'Premium Plan' (needed for API access)
Create an account (Enter email) and enter the verification code
Enter Name and choose a Password
Accept Terms and Continue
Select 'Individual' or 'Organisation'
Enter Payment Info (or scroll down and skip to enter later)

Create an API Key

On the left navigation, go to 'APIs'
Scroll down to 'OS Places API'
Click 'Start free trial'
Go to 'My Projects'
Create a New Project
Accept Terms and continue
Enter Project name 'Colleague'
Click 'Add API'
Scroll down to 'OS Places API'
Press 'Add to Project' then click 'Done'.
Copy 'Project API Key'

Add API to Colleague

Go to Admin > Global Settings
Select the Integrations section
Go to Ordnance Survey API Key
Paste in the API key

Setup Complete.