OS Data Hub API Key Management
The OS Data Hub is the MoJ’s product of choice for incorporating gepgraphic data into applications.
Service Teams require keys to access the APIs.
Pre-requisites
You must have access to the OS Data Hub. If not, please contact your administrator.
Creating a new API key
Login the the OS Data Hub.
Go to “API Dashboard”.
Click on “My Projects”
Click “Create a New Project”.
Enter “Project Name” in the format
<Organisation> <Application> <Type of Environment>.
e.g. HMCTS Apply For Probate Online Production
Click “Create Project” to save the project.
Click “Add API”
Find the correct API and click “Add”
This will take you to the page where you can see the key has been created. You should copy the Project API Key. This is the key that you will send to the requester.
Note - This key is a secret and should only be transfered via a secure method e.g. email of an encrypted archive with password in a separate message.
Rotating an API key
Login the the OS Data Hub.
Go to “API Dashboard”.
Click on the link to the project for the key you wish to revoke.
Click on “Actions”
Select “Regenerate API Key”.
A prompt will appear. Enter code provided.
Click “Regenerate API Key” to confirm action and rotate key.
Note that as soon as a key is rotated the old API key will immediatly stop working.
Revoking an API key
Login the the OS Data Hub.
Go to “API Dashboard”.
Click on the link to the project for the key you wish to revoke.
Select “Delete Project”. This will automatically revoke the key.
Revoked keys cannot be recovered.