Skip to content

Latest commit

 

History

History
612 lines (403 loc) · 18.6 KB

CDDO-API-Intro.md

File metadata and controls

612 lines (403 loc) · 18.6 KB
auto-scaling title theme author marp class description url
true
Understanding APIs in Government
themes/cddo
Chris Nesbitt-Smith
true
lead
A presentation on APIs for non-technical senior leaders

Understanding APIs in Government

Chris Nesbitt-Smith | cns.me [CDDO]

    👋     

Chris Nesbitt-Smith | cns.me [CDDO]

  • What
  • How
  • When
  • Where
  • Why ...an API

bg right fit

Platformland:

An anatomy of next-generation public services

anatomyofpublicservices.com

bg cover

bg cover

bg cover

Key Concepts

bg cover

bg fit

bg cover

bg cover

bg cover

bg fit

Endpoint

e.g. https://api.gov.uk/v1

bg cover

bg cover

Types of APIs

RPC (Remote Procedure Call)

SOAP (Simple Object Access Protocol)

REST     

(Representational State Transfer)

GraphQL

Data Formats

JSON (JavaScript Object Notation)

{
  "name": "John",
  "age": 30,
  "city": "New York",
  "children": [
    {
      "name": "Jane",
      "age": 5
    }
  ]
}

XML (eXtensible Markup Language)

<Person>
  <Name>John</Name>
  <Age>30</Age>
  <City>New York</City>
  <Children>
    <Child>
      <Name>Jane</Name>
      <Age>5</Age>
    </Child>
  </Children>
</Person>

CSV (Comma-Separated Values)

Name,Age,City
John,30,New York

ParentName,ChildName,ChildAge
John,Jane,5

Plain Text

John is thirty years old and lives in New York,
he has a child named Jane who is five years old.

    😮‍💨     

The end of the abstract jargon

How Companies Use APIs

1. All teams will henceforth expose their data and functionality through service interfaces.

2. Teams must communicate with each other through these interfaces.

3. There will be no other form of interprocess communication allowed: no direct linking, no direct reads of another team’s data store, no shared-memory model, no back-doors whatsoever. The only communication allowed is via service interface calls over the network.

4. It doesn’t matter what technology they use. HTTP, Corba, Pubsub, custom protocols — doesn’t matter.

5. All service interfaces, without exception, must be designed from the ground up to be externalizable. That is to say, the team must plan and design to be able to expose the interface to developers in the outside world. No exceptions.

6. Anyone who doesn’t do this will be fired.

7. Thank you; have a nice day!

Government and APIs

Data Sharing

bg fit

https://data.police.uk/api/metropolitan/E05009386/events

[
  {
    "contact_details":{},
    "description":"<p>A one-to-one consultation session
    in conjunction with property marking.<\/p>",
    "end_date":"2024-12-11T15:00:00",
    "title":"Property Marking Scheme",
    "address":"Bike Marking and Phone Marking
    schemes @ Lauriston Road, E9 (Opposite Fish House)",
    "type":"meeting",
    "start_date":"2024-12-11T13:30:00"
  },
]

bg cover

bg fit

bg cover

😀

Future of Public Services

One Government

👩‍🔧 🏚️➡️🏡

APIs in Government Today

DVLA

  • Photo at the Roadside enquiry API service
  • Provide DVSA a service to check theory test eligibility.
  • Digitise paper-based prosecutions with HMCTS

bg fit

bg cover

Challenges?

Key points:

  • Essential building blocks for modern digital services
  • Seamless data sharing and reduce duplication
  • Strategic asset, not just a technical tool
  • More integrated citizen experiences

> EOM

(end of message)

digitalpeople.blog.gov.uk/2024/09/17/get-cloud-certified-this-autumn

<iframe src="https://digitalpeople.blog.gov.uk/2024/09/17/get-cloud-certified-this-autumn/" width="100%" height="80%" style="zoom:0.5"></iframe>
<style scoped> h2 { position: absolute; bottom: 1ch; left: 2vw; width: 95% } </style>

🙏 Thanks 🙏

bg right

  • cns.me    |    talks.cns.me

  • Platformland by Richard Pope
  • Government as a Platform by Tim O'Reilly
  • api.gov.uk

Chris Nesbitt-Smith

Q&A🙋‍♀️🙋🙋‍♂️

bg opacity:0.2