Upload
others
View
3
Download
0
Embed Size (px)
Citation preview
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
Improving API development within government organizations
Ken Coenen12 december 2019
5
FOD Financiën: MyMinFin
Real estate
Deeds
...
Vehicles
Taxes
6
7
Flanders: Mijn Burgerprofiel
Federaal
...Lokaal
Vlaams
8
Aggregate data from various public services
360 degree view of your citizen
Citizen-centricity is key
Real estate
Fines
Identity
Vehicles
Premiums
Permits
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
There are many ways to exchange data
10
11
12
Application Programming Interfaces (API’s)
13
API in a Tweet
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
Does my public service already have an API Strategy?
15
API lifecycle phases
Idea
Design
Implementation
DeploymentPublication
Deprecation
Retirement
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
“Do we think through enough as a public service how the new API will
extend our business model?”
17
What are my API business objectives?
An API should achieve the public service’s business goals in some way
What citizens or other public services do we want to target?
Ideation phase
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
“Do we already practice a contract-first approach within our public
service?”
20
Contract-first aka. API-first
Make sure your organization uses a contract-first approach- Design contracts based on API guidelines
Leverage an API design tool Share contracts with future
consumers Early feedback Reduce the time to market
Design phase
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
“Did we already define API Guidelines within our organization?”
22
Organization-wide API guidelines
Set a standard for all your API’s within your organization- RESTful best practices- Use of right HTTP Methods- API Versioning yes or no- JSON, JSON-LD, XML, …?- Etc.
Design phase
23
Zalando API guidelines
https://opensource.zalando.com/restful-api-guidelines/
24
“Does my company already have a preferred technology stack?”
27
Organization-wide Technology Radar
Set a standard how development and deployment is done within your organization- Techniques- Tools- Languages & frameworks- Platforms
Implementation phase
28
Ordina JWorks Tech Radar
https://ordina-jworks.github.io/tech-radar
29
Ordina JWorks Tech Radar
https://ordina-jworks.github.io/tech-radar
Languages & frameworks
31
“Are the API’s within my company already discoverable via a discovery tool?”
32
My API is deployed to production: What’s next?
Help your partners and other third parties discover your APIs
Think of an API Discovery Portal for your organization- Clear documentation- Easy-to-consume development portal
Host a hackaton to spread awareness Monitor your API
Publication phase
33
Data.gov.be
https://data.gov.be/nl
38
API in a Tweet
39
Contract-firstAPI guidelines Technology radar Discoverable
Questions?