API Developers Breakfast Technical overview use and features

API Developers Breakfast Technical overview, use and features available Mike Thacker, Dominic Skinner and Steve Messer Porism Limited 9 July 2015 api. esd. org. uk

What is the API? A set of RESTful web methods that feed data to front feed applications. See: http: //webservices. esd. org. uk/explain @LGInform. Plus api. esd. org. uk

What you get • Everything that drives the LGA’s own applications for benchmarking and small area profiling • Data (see datasets) maintained by Research and Information team • Sound statistical analysis (see value types) @LGInform. Plus api. esd. org. uk

Applying a consistent framework Metrics • 2, 917 metric types with values • 49 million metric values available Ministry of Justice Audit Commission National Adult Social Care Intelligence Service Chi. Mat CIPFA Statistical Information Services (NASCIS) Clinical and Health Outcomes Knowledge Base Ne. SS data exchange Communities and Local Government Nomis Community Health Profiles North West Health Observatory Department for Education Ofcom Department for Environment, Food and Rural Office for National Statistics Affairs Ofsted Department for Transport Public Health England Department for Work and Pensions South West Health Observatory Census year Academic year Department of Energy and Climate Change Sport England Calendar year Financial quarter Department of Health Tenant Services Authority Month Three-year winters Department of Transport The Elections Centre, Plymouth University Financial year Election year Health and Social Care Information Centre The Insolvency Service Calendar quarter Age band Fire cause HM Revenue & Customs The Planning Inspectorate Employment status. Agency. Gender Home Office Valuation Office Ethnicity Location Local Government Association Youth Justice board Fatal or non-fatal Survey. LSOA method Local Government Ombudsman City districts MSOA Community impact areas Ward Community networks District council Constituencies County council Draft/new wards Single tier council Parishes Region Partnership areas Country Regen projects Sub-wards Thames corridor Town centres Villages (+ 85 million in back end) • • • @LGInform. Plus many data sources consistent time periods consistent breakdowns large to small official statistical areas other areas api. esd. org. uk

How metric values are defined Metrics Areas All types Id 1 - Population All types All counties Time periods All types Calendar year 2014 Population of all counties of England in 2014 @LGInform. Plus api. esd. org. uk

API keys • Sign in and request a key • Public key is for quick use • Public private key is to ‘sign’ live calls • OAuth is to recognise individual users (if you need to) @LGInform. Plus api. esd. org. uk

Some simple examples The following Java. Script examples use no server side code whatsoever! Include j. Query Library Insert your Public Key Call web service with public key using JSONP Parse returned JSON and output data @LGInform. Plus api. esd. org. uk

Some simple examples Want to see the API in action? Download the examples and create your own security keys. Replace YOUR_PUBLIC_KEY with the public key you have created. Save and open the HTML file to view. @LGInform. Plus api. esd. org. uk

Public Private Key example This simple PHP function takes a URL (like the one shown earlier) and appends an Application Key. It then generates a signature from the URL and Private Key. Examples can be found on File Exchange. @LGInform. Plus api. esd. org. uk

Help with metric types See standards pages @LGInform. Plus api. esd. org. uk

Help with web methods Use the data tool or see ‘Explain’ in web methods tool See example @LGInform. Plus api. esd. org. uk

Help with anything API-related See API help @LGInform. Plus api. esd. org. uk

Further information API: api. esd. org. uk Help: help. esd. org. uk / support@esd. org. uk Tim. Adams@local. gov. uk Mike. Thacker@esd. org. uk @Dr. Tim. Adams Mike @LGInform. Plus @Mike. Thacker Dom Steve api. esd. org. uk