/
How to configure third party systems with OS Maps API

How to configure third party systems with OS Maps API

Introduction

Depending on your system, you can configure the OS Maps API WMTS service directly from OS or the OS Maps API WMTS service from ADS, you can see more details on what is being provided here Astun Data Services - ADS | Overview of base mapping available via Astun Data Services & OS Maps API[hardBr.... If your system doesn’t support WMTS, you can use the OS Maps API WMS or OS Maps API EPSG:3857 ZXY services provided by ADS.

Ordnance Survey provides instructions for some GIS software systems on how to configure the OS Maps API WMTS service, and you can find them here https://docs.os.uk/os-apis/accessing-os-apis/os-maps-api/getting-started#instructions. You can also find our guide about configuring QGIS here Configuring QGIS to use OS Maps API WMTS/WMS base maps.

Prerequisites

Before starting you will need:

  1. A valid OS Maps API key can be obtained from OS Data Hub. You can find instructions on how to generate an API key in this guide How to create a Project and generate an API key in OS Data Hub

  2. The URL of the available services and what layers they support

Available services

OS Maps API WMTS service via OS

URL: https://api.os.uk/maps/raster/v1/wmts?key=your-API-key-goes-here

Supported layers:

  1. EPSG 3857

    1. Light_3857

    2. Outdoor_3857

    3. Road_3857

  2. EPSG_27700

    1. Light_27700

    2. Outdoor_27700

    3. Road_27700

OS Maps API XYZ service via OS

URL:https://api.os.uk/maps/raster/v1/zxy/{LAYER}/{z}/{x}/{y}.png?key=your-API-key-goes-here

Supported layers:

  1. Leisure_3857

  2. Road_3857

  3. Outdoor_3857

  4. Light_3857

OS Maps API WMTS service via ADS

URL: https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/service?REQUEST=GetCapabilities&SERVICE=WMTS&key=your-API-key-goes-here

Supported layers:

  1. EPSG 3857

    1. Road_3857

    2. Road_3857_Grayscale

  2. EPSG_27700

    1. Road_27700_Grayscale

    2. Outdoor_27700

    3. Outdoor_27700_Grayscale

    4. Light_27700

    5. Light_27700_Grayscale

    6. Leisure_27700

    7. Leisure_27700_Grayscale

    8. Leisure_25k_27700

    9. Leisure_50k_27700

OS Maps API XYZ service via ADS

URL:https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/tiles/{LAYER}/{z}/{x}/{y}.png?key=your-API-key-goes-here

Supported layers:

  1. Road_3857

  2. Road_3857_Grayscale

OS Maps API WMS service via ADS

URL: https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/service?key=your-API-key-goes-here

Supported layers:

  1. Leisure_27700

  2. Road_27700

  3. Road_27700_Grayscale

  4. Outdoor_27700

  5. Outdoor_27700_Grayscale

  6. Light_27700

  7. Light_27700_Grayscale

  8. Leisure_27700_Grayscale

  9. Leisure_25k_27700

  10. Leisure_50k_27700

Example configurations

Capita One system

As far as we are aware, there are two ways to configure basemapping in the Capita One system:

  1. In the first configuration you need to use the following structure of the WMS service (via ADS) pointing to the TileServerLinkPatern option:

    https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/service?key=your-API-key-goes-here&SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&LAYERS=Road_27700&STYLES=&SRS=EPSG:27700&BBOX={B}&WIDTH=256&HEIGHT=256&FORMAT=image/png

    Here is an example provided by Cardiff Council:

    chrome_q8RGmFtxsM.png

     

  2. In the second configuration, you need to use the following structure of the WMS service (via ADS) pointing to the TileServerLinkPatern option:

    https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/service?key=your-API-key-goes-here

    Here is an example provided by Cardiff Council:

    chrome_67LWd9TyEk.png

CRM embedded with ol-ishare

If you are on iShare version 6 and you have a CRM which is embedded with one of our ol-ishare products, such as spotlight, logger, or litemap you need to know that you can’t use the WMTS service directly from OS as ol-ishare doesn’t support WMTS yet. However, you have two options:

  1. You can either create a WMTS BaseMap in studio and use our WMTS service, https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/service?key=your-API-key-goes-here, which is falling back to WMS when WMTS is not available

  2. Or you can create a WMS BaseMap in studio and use our WMS service, the URL is the same https://map.services.astuntechnology.com/your-organisation-goes-here/osmaps/service?key=your-API-key-goes-here