{"_id":"55e970158b72bb3700b1d5a4","parentDoc":null,"githubsync":"","project":"55e06494a44fae0d002146aa","version":{"_id":"55e06495a44fae0d002146ad","project":"55e06494a44fae0d002146aa","__v":54,"createdAt":"2015-08-28T13:39:33.907Z","releaseDate":"2015-08-28T13:39:33.907Z","categories":["55e06496a44fae0d002146ae","55e06997a44fae0d002146c2","55e06a6958c5460d0076aa0c","55e06ae66bad670d0081f25c","55e06cc1a44fae0d002146cb","55e06ddda44fae0d002146cd","55e95f261fd7e82300ef359f","55e95fe47fc27b2d00d32cfa","55e96eef358d923700be984d","55e96ef6358d923700be984e","55e96efda7ca823900ad547e","55e96f04a7ca823900ad547f","55e970cc358d923700be9853","55e973f4358d923700be9858","55e973f9a7ca823900ad548c","55e977bf358d923700be985d","55e9780f8b72bb3700b1d5bd","55e97815a7ca823900ad5493","55e9781c358d923700be985f","55e97821461e2a390050f23b","55f963c23bb4bb0d0022d18c","5624c67406e8040d005ed6b2","5624dcf25a86b423009462e8","5625f229d0f87e190014c4ed","5627819fe2ce610d004e3ec8","562781b23a4c6b0d00c4556b","5627837166c62617009d17e2","5627851efcbbc621004ebff1","5627860044c87f0d00fe6491","562e3c6d54a5be0d00070c3e","564c955aae6cb82100dc137a","5652e22abbe7110d00dba748","5652f25523d4262d00b21c58","5652fdad51e4e81900bf2452","5652fdcbb60abb1700bafadc","5654494f65bec717007e0293","565da11a77f0090d005818ff","565f063f413e06170093de18","565f06fb413e06170093de21","56dd6773efaca42900e5f58e","56dd68630c3bb41700b0b037","56dd7d24d5419f170075dfb3","56dd9448c117291700015b60","56dd9454c117291700015b61","577a6f8b9748b80e00ef3f45","577a6f969748b80e00ef3f46","577bba7f6e5f301900fada99","57a9cc8e5b1ace0e00de743f","58aab134c50c33250046b8f8","58aab146aecc3e2500573d4c","58aab1628f862f250076f92e","58aab1938f862f250076f92f","58aab3e5aecc3e2500573d56","58aab3f2aecc3e2500573d57"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"55e06cc1a44fae0d002146cb","pages":["55e06d766bad670d0081f263","55e06dcd186ca30d00f9b44d","55e0813b186ca30d00f9b46b","55e9771139c5042d00912b3c","55e9772c8b72bb3700b1d5b8","55e9774e39c5042d00912b3e","55e977758b72bb3700b1d5bb","5624d84d72ac510d00e49198","564c9540caea7a1700a25a0d","564c978745d0362b00a58b8e"],"project":"55e06494a44fae0d002146aa","__v":10,"version":"55e06495a44fae0d002146ad","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-28T14:14:25.894Z","from_sync":false,"order":1,"slug":"os-maps-coming-soon","title":"OS Maps"},"__v":18,"user":"55c9b7b4e4927a0d0004a727","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-04T10:19:01.902Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":2,"body":"Authentication uses the “key” parameter followed by the customer’s API key. All requests must be made over HTTPS.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Authentication\"\n}\n[/block]\nAll requests must be encoded correctly according to standard percent-encoding procedures for a URI.\n(“percent-encoding” links to: http://www.w3schools.com/tags/ref_urlencode.asp)\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Use your own API Key\",\n  \"body\": \"Throughout our documentation you can use your own API key wherever you read YOUR_APP_KEY to run the examples we provide. Simply [sign up for a free trial](https://developer.ordnancesurvey.co.uk/os-maps-api-enterprise) and enter the key when prompted. The key automatically populates the examples, so you only need to do this once.\\n\\nCurrently your app key is set to: [[app:key]]\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Encryption\"\n}\n[/block]\nAs a user of our APIs you are currently free to use encrypted (https) or unencrypted (http) requests. We always advocate using encrypted connections where possible, though acknowledge that there are legitimate and justified use cases for not using encryption.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Ordnance Survey APIs no longer support calls made using SSL v2/v3 or TLS v1.0/v1.1.\\nAll calls made to any of our APIs must support TLS v1.2 as of 24th October 2018 in line with current cyber security recommendations.\\nMore information can be found on [our dedicated support page](https://developer.ordnancesurvey.co.uk/tls-retirement).\",\n  \"title\": \"SSL/TLS\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Encoding\"\n}\n[/block]\nAll requests must be encoded correctly according to standard [percent-encoding](http://www.w3schools.com/tags/ref_urlencode.asp) procedures for a URI.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What are the response codes?\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Official description\",\n    \"0-0\": \"200\",\n    \"0-1\": \"OK\",\n    \"h-2\": \"Explanation in context of the API\",\n    \"1-1\": \"Not Modified\",\n    \"1-0\": \"304\",\n    \"2-0\": \"400\",\n    \"3-0\": \"401\",\n    \"4-0\": \"404\",\n    \"5-0\": \"405\",\n    \"6-0\": \"500\",\n    \"7-0\": \"503\",\n    \"2-1\": \"Bad request\",\n    \"3-1\": \"Unauthorized\",\n    \"4-1\": \"Not found\",\n    \"5-1\": \"Method not allowed\",\n    \"6-1\": \"Internal server error\",\n    \"7-1\": \"Service unavailable\",\n    \"0-2\": \"Request had been successful.\",\n    \"1-2\": \"In response to a conditional GET request this response indicates that the underlying data has not changed since the previous request, and cached results may be re-used.\",\n    \"2-2\": \"E.g. missing query parameter, malformed syntax.\",\n    \"3-2\": \"The client has not provided authentication or incorrect authentication.\",\n    \"4-2\": \"The server has not found anything matching the Request-URI.\",\n    \"5-2\": \"Request used an unsupported HTTP method, e.g. DELETE or PUT.\",\n    \"6-2\": \"Generic internal server error.\",\n    \"7-2\": \"E.g. due to overloading or maintenance.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Service Checks\"\n}\n[/block]\nTo check that the service is running correctly, the below URL is used to test the service:\n\nhttps://api2.ordnancesurvey.co.uk/mapping_api/v1/service/wmts?Request=GetCapabilities&key=[[app:key]]\n\n\nUsing your API Key in the query allows you to test your key is working:\n\nhttps://api2.ordnancesurvey.co.uk/mapping_api/v1/service/wmts?Request=GetCapabilities&key=[[app:key]]","excerpt":"","slug":"os-maps-technical-detail","type":"basic","title":"Technical detail"}
Authentication uses the “key” parameter followed by the customer’s API key. All requests must be made over HTTPS. [block:api-header] { "type": "basic", "title": "Authentication" } [/block] All requests must be encoded correctly according to standard percent-encoding procedures for a URI. (“percent-encoding” links to: http://www.w3schools.com/tags/ref_urlencode.asp) [block:callout] { "type": "info", "title": "Use your own API Key", "body": "Throughout our documentation you can use your own API key wherever you read YOUR_APP_KEY to run the examples we provide. Simply [sign up for a free trial](https://developer.ordnancesurvey.co.uk/os-maps-api-enterprise) and enter the key when prompted. The key automatically populates the examples, so you only need to do this once.\n\nCurrently your app key is set to: [[app:key]]" } [/block] [block:api-header] { "title": "Encryption" } [/block] As a user of our APIs you are currently free to use encrypted (https) or unencrypted (http) requests. We always advocate using encrypted connections where possible, though acknowledge that there are legitimate and justified use cases for not using encryption. [block:callout] { "type": "warning", "body": "Ordnance Survey APIs no longer support calls made using SSL v2/v3 or TLS v1.0/v1.1.\nAll calls made to any of our APIs must support TLS v1.2 as of 24th October 2018 in line with current cyber security recommendations.\nMore information can be found on [our dedicated support page](https://developer.ordnancesurvey.co.uk/tls-retirement).", "title": "SSL/TLS" } [/block] [block:api-header] { "type": "basic", "title": "Encoding" } [/block] All requests must be encoded correctly according to standard [percent-encoding](http://www.w3schools.com/tags/ref_urlencode.asp) procedures for a URI. [block:api-header] { "type": "basic", "title": "What are the response codes?" } [/block] [block:parameters] { "data": { "h-0": "Code", "h-1": "Official description", "0-0": "200", "0-1": "OK", "h-2": "Explanation in context of the API", "1-1": "Not Modified", "1-0": "304", "2-0": "400", "3-0": "401", "4-0": "404", "5-0": "405", "6-0": "500", "7-0": "503", "2-1": "Bad request", "3-1": "Unauthorized", "4-1": "Not found", "5-1": "Method not allowed", "6-1": "Internal server error", "7-1": "Service unavailable", "0-2": "Request had been successful.", "1-2": "In response to a conditional GET request this response indicates that the underlying data has not changed since the previous request, and cached results may be re-used.", "2-2": "E.g. missing query parameter, malformed syntax.", "3-2": "The client has not provided authentication or incorrect authentication.", "4-2": "The server has not found anything matching the Request-URI.", "5-2": "Request used an unsupported HTTP method, e.g. DELETE or PUT.", "6-2": "Generic internal server error.", "7-2": "E.g. due to overloading or maintenance." }, "cols": 3, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Service Checks" } [/block] To check that the service is running correctly, the below URL is used to test the service: https://api2.ordnancesurvey.co.uk/mapping_api/v1/service/wmts?Request=GetCapabilities&key=[[app:key]] Using your API Key in the query allows you to test your key is working: https://api2.ordnancesurvey.co.uk/mapping_api/v1/service/wmts?Request=GetCapabilities&key=[[app:key]]