Magento Web API Ecosystem. Imagine 2018
Download as PPTX, PDF3 likes569 views
The document discusses Magento's web API ecosystem and asynchronous APIs. It describes benefits like business agility, innovation potential, and lower costs. Good APIs support business strategy, help users reach goals, and have intuitive developer experiences. Magento's vision is for rich API coverage, performance, scalability, documentation, and tools. Asynchronous APIs allow bulk operations and return job IDs, while status endpoints check operation results. Load tests showed asynchronous APIs improved response times over synchronous APIs under high load.
![Bulk APIs
• Allow to send multiple entities to API endpoint in one request
POST /async/bulk/V1/products
[
{
"product": {...}
},
{
"product": {...}
}
…
]](https://image.slidesharecdn.com/imagineapiecosystem-180501221923/85/Magento-Web-API-Ecosystem-Imagine-2018-22-320.jpg)
![Asynchronous Response
202 Accepted
{
"bulk_uuid": "b8b79af4-fe6a-4f8a-a6f3-76b6e95aeec8",
"request_items": {
"items": [
{
"id": 0,
"data_hash": null,
"status": "accepted"
}
]
}
}](https://image.slidesharecdn.com/imagineapiecosystem-180501221923/85/Magento-Web-API-Ecosystem-Imagine-2018-25-320.jpg)
![Status Endpoints
• GET /V1/bulk/:bulkUuid/status
• GET /V1/bulk/:bulkUuid/detailed-status
{ "operations_list": [{
"id": 0,
"topic_name": ”/async/products",
"status": 0,
"result_serialized_data": ”{…}",
"result_message": "",
"error_code": 0
}],
"extension_attributes": {},
"bulk_id": " b8b79af4-fe6a-4f8a-a6f3-76b6e95aeec8 ",
"description": "string",
"start_time": "string",
"user_id": 0,
"operation_count": 0
}](https://image.slidesharecdn.com/imagineapiecosystem-180501221923/85/Magento-Web-API-Ecosystem-Imagine-2018-26-320.jpg)
Magento Web API Ecosystem. Imagine 2018
- 3. Eugene Tulika Magento 2 Architect, Community Engineering | Magento @vrann Misha Kotov Sr. Product Manager | Magento @mish_capish
- 6. Benefits Business Agility • Support for virtually all external systems • Ultimate platform flexibility Innovation Potential • Unlimited customization potential • Piecemeal platform consumption Lower Total Cost of Ownership (TCO) • Minimized integration efforts • Streamlined Magento implementations • Reduced conflicts and maintenance Faster Time to Market (TTM) • Accelerated development • Shorter learning curve
- 8. What makes a good API? • Support overall business strategy • Help users reach strategic objectives • Embody strong developer experience – Intuitive – Fast – Reliable – Extensible
- 9. Vision for Magento APIs Rich coverage Performance Scalability Documentation Tooling Developer experience Customization Standardization
- 10. Web API use in Magento • 3rd party back-office integrations • Extensions – Back-end – Front-end • Mobile applications • Front-end customizations – Headless – PWAs ... Accounting Item-level inventory management POS management Loyalty program management Sales Promotions Sales forecasting Data exchange Invoice processing KPI monitoring Price management Workflow management Supply chain Manufacturing Supplier price book management HR ...
- 11. Unlock the Future • Virtual Reality (VR) • Augmented Reality (AR) • Voice Assistants • Chat Bots • Connected Devices • IOT • Artificial Intelligence (AI) • Machine Learning
- 13. SOAP • Designed for system integrations • Relies on XML, WSDL • Built-in error handling • Language-, platform-, transport- neutral • Decreasing use in modern tech
- 14. REST • GET/POST/PUT/DELETE commands • HTTP status codes • Various data formats • Multiple authentication methods • Wide adoption
- 15. GraphQL • Accomplishes more with one API call • Developer gets exactly (and only) the requested data • Documentation is a first-class citizen • Deprecation in a first-class citizen • Introspection and graphical tooling Demo (if time allows)
- 16. GraphQL • First experimental release – Storefront data only – Support for products, categories, customer, EAV, scopes – Custom resolvers – Testing framework – Error handling, helpers • Next – Performance improvements – Support for checkout, payments, orders, My Account • Get involved! https://github.com/magento/graphql-ce/wiki
- 17. Play nice with others
- 18. Magento Asynchronous and Bulk APIs
- 19. Use Case • ERP system sends all updated entities to the Magento Web API at once – resulted in a massive database overload. This caused performance to decrease, affecting conversions as well as the shoppers’ user experience. • ERP system is not capable of tracking error messages. • ERP system should say online till the process finished.
- 20. Usage of Message Queues
- 21. Asynchronous APIs Endpoint Prefix Every existing Magneto 2 Web API Endpoint is converted to asynchronous by adding /async prefix (for PUT/POST/DELETE requests only) Examples: • POST /async/V1/orders/:id/cancel • PUT /async/V1/customer • DELETE /async/V1/products/:sku • …
- 22. Bulk APIs • Allow to send multiple entities to API endpoint in one request POST /async/bulk/V1/products [ { "product": {...} }, { "product": {...} } … ]
- 23. Bulk Asynchronous APIs Endpoint Prefix • For any existing Magneto 2 Web API Synchronous endpoints • Adding prefix /async/bulk enables accepting array of entities • for PUT/POST/DELETE requests only – i.e.: for POST /V1/products analogue bulk endpoint is: POST /async/bulk/V1/products
- 24. Dealing with Parameters in Bulk Requests Consider PUT /V1/product/my-first-product-1/options/3 • This endpoint has information in request path related to particular resource, so cannot accept array of different resources. To construct equivalent Bulk endpoint we should rewrite parameters placeholders replacing “:” with “by”, i.e.: • PUT /V1/product/:sku/options/:optionId => PUT /async/bulk/V1/product/bySku/options/byOptionId • The value of the parameters should be passed as the part of the entity body.
- 25. Asynchronous Response 202 Accepted { "bulk_uuid": "b8b79af4-fe6a-4f8a-a6f3-76b6e95aeec8", "request_items": { "items": [ { "id": 0, "data_hash": null, "status": "accepted" } ] } }
- 26. Status Endpoints • GET /V1/bulk/:bulkUuid/status • GET /V1/bulk/:bulkUuid/detailed-status { "operations_list": [{ "id": 0, "topic_name": ”/async/products", "status": 0, "result_serialized_data": ”{…}", "result_message": "", "error_code": 0 }], "extension_attributes": {}, "bulk_id": " b8b79af4-fe6a-4f8a-a6f3-76b6e95aeec8 ", "description": "string", "start_time": "string", "user_id": 0, "operation_count": 0 }
- 27. Load Testing Increasing number of parallel threads, Sync vs Async, average response time
- 28. Load Testing Increasing number of parallel threads, Sync vs Async, Errors Rate
- 29. Swagger Support
- 30. Building Feature with Community • Project started in December 2017 initiated by Magento Solution partners: • Requirements discussion and architecture design till January 2018 • 3 developers total participated from comwrap and Balance Internet side • Implemented and Merged to Magento 2.3 Open Source release line – March 2018
- 31. Phase 2 of the project • Performance improvements with Redis • API for search on Statuses • Status Endpoints for the Entities https://github.com/magento/commu nity-features/projects/1
- 32. Thank you!