Upgrade to Pro — share decks privately, control downloads, hide ads and more …

apidays London 2022 - Consumer first API in Open Banking, Chris Dudley, IBM

apidays
October 30, 2022

apidays London 2022 - Consumer first API in Open Banking, Chris Dudley, IBM

apidays London 2022 - The Path from Open Banking to Embedded Finance
October 26 & 27, 2022

Consumer first API in Open Banking
Chris Dudley, Architect, IBM API Connect at IBM
------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/

Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW

apidays

October 30, 2022
Tweet

More Decks by apidays

Other Decks in Programming

Transcript

  1. Consumer-first APIs — Chris Dudley Architect, IBM API Connect

  2. 2022 SERIES OF EVENTS New York JULY (HYBRID) Australia SEPTEMBER

    (HYBRID) Singapore APRIL (VIRTUAL) Helsinki & North MARCH (VIRTUAL) Paris DECEMBER (HYBRID) London OCTOBER (HYBRID) Hong Kong AUGUST (VIRTUAL) JUNE (VIRTUAL) India MAY (VIRTUAL) APRIL (VIRTUAL) Dubai & Middle East JUNE (VIRTUAL) Check out our API Conferences www.a pida ys .globa l Want to talk at one of our conferences? apidays.typeform.com/to/ILJeAaV8
  3. Why does no-one want to use my APIs? 2 October

    2022 / © 2022 IBM Corporation
  4. API Design Protocol Responses Examples Formats October 2022 / ©

    2022 IBM Corporation 3
  5. Protocol REST/JSON (OAI2/3) SOAP Proxy GraphQL AsyncAPI October 2022 /

    © 2022 IBM Corporation 4
  6. Responses Use proper response codes Provide example error responses Use

    useful error messages “An error occurred.” vs “Website addresses must be valid URLs starting with https://” Use validation, reject invalid API requests with clear information on what’s wrong and how to fix it October 2022 / © 2022 IBM Corporation 5
  7. Examples Provide examples for Everything! (parameters, request objects, response objects

    … everything!) Realistic examples – e.g. “90210” for ‘zipCode’ Examples for every content type you accept Provide code snippets – e.g. cURL, NodeJS, etc.. Especially authentication October 2022 / © 2022 IBM Corporation 6
  8. Formats Use capabilities of JSON Schema / Avro Proper typing

    Optional format attribute (email, url, …) HTML 5 input fields for client-side validation Regular expression pattern matching October 2022 / © 2022 IBM Corporation 7
  9. What else? Documentation Ecosystem October 2022 / © 2022 IBM

    Corporation 8
  10. Documentation Language Markdown Examples Live test tool Code samples SDK

    Authentication October 2022 / © 2022 IBM Corporation 9
  11. Grow the ecosystem Case studies (why use this API) Blogs

    Community engagement What’s new Video tutorials October 2022 / © 2022 IBM Corporation 10
  12. One more thing…. Ask for feedback Polls NPS Continuous improvements

    October 2022 / © 2022 IBM Corporation 11
  13. Success! October 2022 / © 2022 IBM Corporation 12

  14. Further Reading How to document an API: https://community.ibm.com/community/user/integration/blogs/chris-dudley1/2021/10/08/how-to- document-an-api API

    Summaries: https://community.ibm.com/community/user/integration/blogs/chris-dudley1/2021/10/29/api- summaries October 2022 / © 2022 IBM Corporation 13