apidays New York 2022 - Beyond API Regulations for Finance, Insurance, and Healthcare July 27 & 28, 2022 Demystifying API Onboarding: A Focus on SDKs Mehdi Raza Jaffery, Chief Product Architect at APIMatic ------------ 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

1. Demystifying API Onboarding:
FOCUS ON SDKs
Mehdi Raza Jaffery
Chief Product Architect
APIMatic

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. Who am I? ➔ Chief Product Architect @ APIMatic
➔ APIMatic Code Generator
➔ APIMatic API Portal Generator
➔ API DX Evangelist
Demystifying API Onboarding - A Focus on SDKs

4. Outline ➔ What are SDKs?
➔ Why are SDKs needed?
➔ How to make great SDKs?
Demystifying API Onboarding - A Focus on SDKs

5. What are SDKs?

6. SDK is everything needed to
write integration code for an API.

7. API Consumer
App
Demystifying API Onboarding - A Focus on SDKs
API Integration Code
Client
Libraries
Models Auth Helpers
API Calls
Language-Specific Docs
Guides Reference
Code Samples

8. Why SDKs?

9. Payment
Orders
Cards
Inventory
Users
Billing
Receipts
Payout
Analytics
Route
JSON
Form
Status Codes
Security
Schemes
HTTP
Method
Headers
Query
Schema
Multipart
Methods
Classes
Product REST API User App
Data
Logic
Tests

10. Payment
Orders
Cards
Inventory
Users
Billing
Receipts
Payout
Analytics
Route
JSON
Form
Status Codes
Security
Schemes
HTTP
Method
Headers
Query
Schema
Multipart
Application
Logic
API Integration
Logic
Product REST API User App
Request
Response

11. Integration is the
end-goal, but…
➔ …it is also the hardest phase
because it is expensive for the company
as it consumes dev time.
➔ Therefore, it deserves the most investment
on part of the API Provider too
in the form of SDKs.

12. Demystifying API Onboarding - A Focus on SDKs

13. Demystifying API Onboarding - A Focus on SDKs

14. Demystifying API Onboarding - A Focus on SDKs

15. “API delivers the product; SDK is
the interface”

16. How to Make Great
SDKs?

17. “SDKs should
speak the language
of the
developers.”

18. 1. SDKs should be REST-Agnostic

19. 1. SDKs should be REST-Agnostic

20. 2. SDKs should be idiomatic to the language
async CreateInvoiceItem(item)
async GetInvoiceItem(id)
async UpdateInvoiceItem(item)
async DeleteInvoiceItem(id)
async ListInvoiceItem()
C# SDK

21. 3. SDKs should be consistent with the API
async CreateInvoiceItem(item)
async GetInvoiceItem(id)
async UpdateInvoiceItem(item)
async DeleteInvoiceItem(id)
async ListInvoiceItem()
C# SDK

22. “SDKs should
make API integrations
happen
faster.”

23. 4. SDK should get to Hello
World in 1, 2, 3
3. Run Code Sample
1. Install Package
2. Setup SDK

24. “SDKs should help developers
fight code decay.”

25. Releases
End-of-Life
5. SDKs should help users navigate language updates

26. 6. SDKs should help users navigate dependency updates

27. “SDKs should help
write code that
works in all cases.”

28. 7. SDKs should provide strong-typing through API
types
Prevent incorrect requests
before the app runs.
Demystifying API Onboarding - A Focus on SDKs

29. 8- SDKs should provide runtime checks
Prevent incorrect requests
while the app is running.
Nope!

30. “SDKs should
protect against the
effects of distributed systems.”

31. 9. SDKs should recover from transient failures
3. Circuit breaker
1. Timeout and Retries
2. API Throttling

32. SUMMARY: SDKs Design Principles
Circuit breaker
Timeout and
Retries
API Throttling
Reliable
Maintainable
Ensure
dependencies are
up to date
Provide complete code
with types
Track language versions
Compile-time
checks
Runtime checks
Robust
Clean Code
Samples
Publish
Packages
Simple SDK
Setup
Approachable
REST-Agnostic
Interface
Idiomatic
Accessible
Consistent

33. Demystifying API Onboarding - A Focus on SDKs
www.apimatic.io
mehdi@apimatic.io

34. The End