Introducing Store API

Why do we always struggle to articulate the benefits of an API-led architecture without using tech jargon. A developer-directed refresher on API design, evident headless scenarios, and the new Shopware Store API.

Transcript

1. Welcome Community
2. Let‘s talk about APIs 1. Why APIs? 2. How it works 3. How it’s used
3. What comes to mind and what do we use them for? Data transfer Connection Integration Headless SOA Performance Decoupling Synchronisation Webhooks REST SOAP Import/Export Communication Distribution
4. APIs & Developers are Friends W** does that mean? *consumers
5. Which problem are we solving?
6. „Consumer or customer experience is first and foremost“ - Joe Cicman, Forrester
7. I got lots of mails along the lines of:
8. Can I use Shopware in my existing Single Page Application?
9. How should I integrate Shopware into my brand website?
10. Can I use React?
11. But we just need the checkout!
13. Sales-Channel API For the rescue!
14. cart order login product register search /cart /order /login /product /register /search /sales-channel-api * / = APIfication of a piece of logic
15. But there was a problem.
16. Product Detail Page title gallery price description crossselling items
17. PDP vs Sales-Channel API title gallery price description crossselling items configurator cms page /cart /order /register /login /product /search
18. Store API vs Sales-Channel API title gallery price description crossselling items configurator cms page /cart /order /register /login /product /search /title /gallery /price /description /crossselling items /configurator /cms page slightly idealised visualisation / = APIfication of a piece of logic Routes
19. There‘s a more general pattern to it Fetch product list ProductListingRoute Store API Detail page Listing page
20. What are the benefits? Generalised exposal of business logic via API More freedom for frontend developers Functional atomisation / coverage Reusability and testability
21. Why is it a new API? Required Rewrites in some parts Not applicable to our versioning system We can keep compatibility for Sales-Channel API Be able to provide new approach and more freedom
22. What does it mean for my code? • We‘re not deprecating the Sales-Channel API yet • Rename your endpoints • Expose mid-level services via Routes • Return reponse DTOs • extend Shopware\Core\System\SalesChannel\StoreApiResponse
23. How to use it
24. Authentication / Access
25. Sparse responses
26. Sparse responses
27. SEO URLs
28. SEO URLs
29. SEO URLs
30. SEO URLs
31. SEO URLs
32. New endpoints CMS Product listings Search Account recovery Contact forms Payment
33. New endpoints CMS Product listings Search Account recovery Contact forms Payment
34. Got excited? docs.shopware.com/en/shopware-platform-dev-en/store-api-guide @elkmod