The SAP Business ByDesign will be one of the digital cores used in this hackathon. Whatever your prototype does, it needs to integrate somehow with one (or both) the backend systems we provide. The communication is performed using the SAP Business ByDesign APIs, both SOAP and REST-based APIs which implements the Open Data Protocol version 2.
The backend system should be used as a "black box". That means no customizations should created on top of it. We are keeping it vanilla. That means the SAP Cloud Application Studio and other in-app extensibility artefacts/tools are out of the scope and must not be used.
Instead you should build a prototype that takes advantage of a loosely coupled architecture. If you are new to the concept, please take a look at our landing page to check articles and samples.
There are 3 main groups of APIs that you can use to consume SAP Business ByDesign data.
- SOAP API
- Most extensive list of services and objects available. Natively part of SAP Business ByDesign.
- OData API for Business Objects
- Allow users to expose SAP Business ByDesign business objects. Althought not natively available, we created several OData services for this hackathon.
- OData API for Analytics
- Used as read-only, exposes reports and data-sources used in SAP Business ByDesign built-in analytics module as a REST API.
You find an overview of the complete ByD API portfolio in the SAP Community blog post SAP ByDesign API Overview.
- Repository of API Samples that you can import in Postman to understand how to handle the SAP Business ByDesign data using the OData API for Business Objects and the OData API for Analytics
- NOTE: In the hackathon systems all configuration has been done and all sample custom odata services have been uploaded. Hackathon participants just have to download the Postman collections and Postman environments and enter their hackathon team users and passwords in the Postman environments.
- Check also Import/Export Postman Collections
- OData Example: Read and Write Product Purchasing Data
- Retrieving Analytics Data Using OData
- Using Filter and Selection Parameter in ByD OData for Analytics
- SAP Business by Design - How to Create an OData Service
- Get Employee ID and Business Partner Internal ID using ByDesign OData Services
- Create ByD Sales Orders using Alexa
- Create ByD Sales Orders using Web Services
- Read and Write ByDesign Attachments using Web Services
- How to get ByDesign Code Lists via Web Service QueryCodeListIn
- Change Product Tax Classifications using Web Service APIs
- Mass Changes of ByD Data using Excel and ByD Web Services
- SAP Business ByDesign Help Portal
- SAP Business ByDesign Community Topic Page
- OData Protocol official documentation
- SAP Business ByDesign Help Portal - Search with key words “OData User Guide”
- SAP Business ByDesign Help Portal - Search with key words "Retrieving Analytics Data Using OData"
- SAP Business ByDesign Help Portal - Search with key words "Create and Edit a Cloud Data Source“