sap-samples/byd-api-samples

1. This repository is not an application runtime; it is a sample asset pack for SAP Business ByDesign integration testing and learning. The two main artifact types are Postman collections/environments and SAP ByDesign Custom OData Service definitions.

2. The external system boundary is SAP Business ByDesign. All request flows target ByD OData APIs exposed by a tenant, typically a partner demo tenant or another configured ByD system. The repository itself contains no server-side code or executable service.

3. The Postman/ folder is the primary client-side layer. Each .postman_collection.json defines a scenario-driven request sequence, and each matching .postman_environment.json supplies tenant URL, business user credentials, communication user credentials, and test data variables.

4. The collections are organized by business domain rather than technical layer: Analytics, Master Data, Reference Scenarios, Projects, Sales and Commerce Scenarios, Internal Logistics, New Business, and Supplier Invoicing. Each collection models a business process and uses ordered OData calls to create, change, read, and sometimes chain documents across that process.

5. The request flow is orchestrated inside Postman. Collections contain folders and subfolders with sequences of requests, plus pre-request and test scripts. The runner is intended to execute these sequences in order, preserving variable values and avoiding stored cookies so that state is controlled by the environment and prior responses.

6. The Custom OData Services/ folder contains XML service definitions that must be uploaded into ByD before the Postman collections can run. These are not stand-alone services in the repo; they are metadata/configuration artifacts consumed by ByD to expose the custom endpoints used by the sample requests.

7. The custom services are shared infrastructure across multiple collections. Examples include business partner, customer, supplier, employee, project, sales, purchasing, logistics, and analytical entities. This means the repo has a reusable service layer feeding multiple scenario packages rather than one service per sample.

8. The main data flow is: configure ByD tenant and communication arrangements, upload the custom OData services, import the matching Postman collection and environment, then execute the request chain from Postman against the tenant. Request responses provide IDs and state transitions that subsequent requests use to continue the business process.

9. The repository also encodes an important operational boundary: collections and environments must be paired correctly. A collection depends on its corresponding environment for tenant host, credentials, and scenario-specific variables; mixing them breaks the request flow.

10. In architecture-diagram terms, the system is best drawn as three layers: local sample assets in GitHub, the Postman execution client, and the SAP Business ByDesign tenant with OData endpoints and custom services. The repository’s purpose is to demonstrate how business process APIs and document flows are stitched together across those boundaries.