Slide 1

Slide 1 text

Zdeněk “Z” Němec, February ‘23 API Documentation & AI Augmented API docs & API integration superface.ai

Slide 2

Slide 2 text

Founder & CTO of Superface.ai • Pioneered the API- fi rst approach at Apiary.io → Oracle • Founder of API consulting Good API • Helped several Fortune 100 companies with their API strategy and execution
 • Founder and CTO of Superface.ai Zdeněk “Z” Němec superface.ai

Slide 3

Slide 3 text

SaaS API integrations fatigue superface.ai

Slide 4

Slide 4 text

APIs are hefty burden Accelerated by global pandemic, the need for API integrations grew in 80,4% of companies 700 days Average time needed by a SaaS app to build API integrations superface.ai

Slide 5

Slide 5 text

Why integrations takes so long? superface.ai

Slide 6

Slide 6 text

The truth about API integration Analysis Development Testing Deployment time budget Expectation Analysis Development Reality superface.ai

Slide 7

Slide 7 text

API Analysis superface.ai

Slide 8

Slide 8 text

Superface research Top 6 obstacles when integrating APIs 1. Understanding the API domain model and language 2. Answering the question “Can this API ful fi ll my use-case?” 3. The need to understand the entire ecosystem and documentation of API vendor in order to integrate even a small functionality 4. Ambiguity of my own product requirements 5. Quality of documentation, outdated API specs 6. Access hurdles, certi fi cation, API provider terms superface.ai

Slide 9

Slide 9 text

What are we analyzing? Implemenation Product Business Business rules, commercials, limits, regulations, certi fi cation, SLAs How to connect, API calls, JSONs, API Spec what API o ff ers, what capabilities, what use-cases it carters to superface.ai

Slide 10

Slide 10 text

API documentation today Technical by the (wrong) default • Most often, API docs focus on the technical aspects • The least important one, and the one that changes the most often • API docs are not focusing enough on the product’s capabilities and domain • Business side is usually under-documented Implemenation Product Business superface.ai

Slide 11

Slide 11 text

superface.ai

Slide 12

Slide 12 text

https://openbankinguk.github.io/dcr-docs-pub/v3.3/dynamic-client-registration.html#basics superface.ai

Slide 13

Slide 13 text

Minimizing the analysis today? The tools we have today • Improving the API documentation • Document the business and product aspects in addition to technical reference • SDKs, cURL, Postman collections, examples • Standardization & harmonization • Uni fi ed APIs • “APIs in front of APIs” • Nylas, Hyperswitch, Metapack, Merge superface.ai

Slide 14

Slide 14 text

Next-gen API analysis superface.ai

Slide 15

Slide 15 text

Next-gen API analysis • Analysis will be always needed (for non-commodities) NLP-based 
 augmented human operator Employing LLM/AI to assist in the proces of analyzing and integrating API NLP – Natural Language Processing
 LLM - Large Language Model Self-integrating apps 
 machine-to-machine communication Enabling applications to autonomously discover & connect APIs superface.ai

Slide 16

Slide 16 text

NLP & APIs superface.ai

Slide 17

Slide 17 text

AI client code-gen GitHub Copilot superface.ai

Slide 18

Slide 18 text

AI API interaction design Jurassic-X superface.ai

Slide 19

Slide 19 text

AI API integration OpenAI GPT-3 / ChatGPT superface.ai

Slide 20

Slide 20 text

Superface EDGAR integration code
 on demand analyze API API Your App direct API call EDGAR superface.ai “How to ful fi ll order?" +

Slide 21

Slide 21 text

Superface EDGAR superface.ai

Slide 22

Slide 22 text

AI-enhanced API docs superface.ai

Slide 23

Slide 23 text

API documentation + NLP superface.ai

Slide 24

Slide 24 text

superface.ai API documentation + NLP

Slide 25

Slide 25 text

API documentation + NLP superface.ai

Slide 26

Slide 26 text

superface.ai How AI change API docs?

Slide 27

Slide 27 text

…when it doesn’t need the technical parts? Implemenation Product Business superface.ai

Slide 28

Slide 28 text

• Documentation of business aspects 
 • Explanation of domain models 
 • Focus on use-cases superface.ai

Slide 29

Slide 29 text

Thank you! Let’s talk! Zdenek “Z” Nemec 
 Twitter: @zdne superface.ai superface.ai