To get access to the production environment you need an API key.
How you do this depends on your organisation type.
Public sector organisations, including NHS organisations
To use the API free of charge, become a PSGA member. Then you can manage your own API keys in the OS Data Hub.
General practices cannot become PSGA members, but are unlikely to be building their own software - see 'Private sector software developers' below.
Ordnance Survey has agreed that the OS Places API can be used free of charge within general practice for the specific purpose of ensuring address quality within their Patient Administration System (PAS), so long as address changes are also reflected in the Personal Demographics Service.
Private sector software developers
To use the API free of charge, sign a 'contractor licence' with a PSGA member.
If you are building software for a specific NHS organisation, sign a contractor licence with them. This is likely to be based on Ordnance Survey's standard Public Sector Contractor Licence. If they are not already a PSGA member, they might need to become one first.
Alternatively, you can sign a single contractor licence with us if you are:
- building software for use in multiple NHS organisations
- or building software for general practice
- and your software is integrated with the Personal Demographics Service
To do this, contact us. Once we have checked your use case, we will direct you to sign our customised OS Places contractor licence.
Your sponsoring PSGA member, whether it's us or another organisation, will supply you an OS Places API key using the OS Data Hub.
You do not need a separate API key for each NHS organisation your software is used in - you can use the same API key for all of them.
If we are your sponsoring PSGA member, you must issue Ordnance Survey's Public sector license for end users to each end user organisation that uses your software.