improving api development titel within government ... · organization -wide api guidelines set a...
TRANSCRIPT
![Page 1: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/1.jpg)
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
Improving API development within government organizations
Ken Coenen12 december 2019
![Page 2: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/2.jpg)
5
FOD Financiën: MyMinFin
Real estate
Deeds
...
Vehicles
Taxes
![Page 3: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/3.jpg)
6
![Page 4: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/4.jpg)
7
Flanders: Mijn Burgerprofiel
Federaal
...Lokaal
Vlaams
![Page 5: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/5.jpg)
8
Aggregate data from various public services
360 degree view of your citizen
Citizen-centricity is key
Real estate
Fines
Identity
Vehicles
Premiums
Permits
![Page 6: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/6.jpg)
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
There are many ways to exchange data
![Page 7: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/7.jpg)
10
![Page 8: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/8.jpg)
11
![Page 9: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/9.jpg)
12
Application Programming Interfaces (API’s)
![Page 10: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/10.jpg)
13
API in a Tweet
![Page 11: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/11.jpg)
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
Does my public service already have an API Strategy?
![Page 12: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/12.jpg)
15
API lifecycle phases
Idea
Design
Implementation
DeploymentPublication
Deprecation
Retirement
![Page 13: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/13.jpg)
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
“Do we think through enough as a public service how the new API will
extend our business model?”
![Page 14: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/14.jpg)
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
![Page 15: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/15.jpg)
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
“Do we already practice a contract-first approach within our public
service?”
![Page 16: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/16.jpg)
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
![Page 17: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/17.jpg)
TitelOnderwerpVerantwoordelijke afdeing, personen.Datum
“Did we already define API Guidelines within our organization?”
![Page 18: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/18.jpg)
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
![Page 19: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/19.jpg)
23
Zalando API guidelines
https://opensource.zalando.com/restful-api-guidelines/
![Page 20: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/20.jpg)
24
“Does my company already have a preferred technology stack?”
![Page 21: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/21.jpg)
27
Organization-wide Technology Radar
Set a standard how development and deployment is done within your organization- Techniques- Tools- Languages & frameworks- Platforms
Implementation phase
![Page 22: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/22.jpg)
28
Ordina JWorks Tech Radar
https://ordina-jworks.github.io/tech-radar
![Page 23: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/23.jpg)
29
Ordina JWorks Tech Radar
https://ordina-jworks.github.io/tech-radar
Languages & frameworks
![Page 24: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/24.jpg)
31
“Are the API’s within my company already discoverable via a discovery tool?”
![Page 25: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/25.jpg)
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
![Page 26: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/26.jpg)
33
Data.gov.be
https://data.gov.be/nl
![Page 27: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/27.jpg)
38
API in a Tweet
![Page 28: Improving API development Titel within government ... · Organization -wide API guidelines Set a standard for all your API’s within your organization - RESTful best practices -](https://reader033.vdocuments.us/reader033/viewer/2022051806/5ffb4c29ac84d31ccc463043/html5/thumbnails/28.jpg)
39
Contract-firstAPI guidelines Technology radar Discoverable