CPI Proxy Part 3: Using S/4HANA OData APIs with the OData Adapter
Full lesson currently free to read · AI practice limits apply separately
Call S/4HANA APIs from the SAP Business Accelerator Hub with the OData receiver adapter: discovering APIs, query and create operations, CSRF and batch handling, paging large reads and authorizations for communication users.
Visual overview
Explanation
📌 KEY POINTS
✅ S/4HANA publishes released APIs (OData, SOAP) documented on SAP Business Accelerator Hub.
✅ The OData receiver adapter supports query, read, create, update and batch operations.
✅ Large reads require paging; the adapter can handle paging settings.
✅ Communication arrangements (cloud) or service activation and roles (on-premise) control API access.
⚠️ Using unreleased or custom-built services where a released API exists creates upgrade risk.
━━━━━━━━━━━━━━━━━━━━
▶ WHERE WE ARE
This final part covers modern API-based integration with S/4HANA.
━━━━━━━━━━━━━━━━━━━━
▶ 1. RELEASED APIS
SAP Business Accelerator Hub lists released APIs for S/4HANA, such as Business Partner, Sales Order or Product APIs, with documentation and try-out options. Released APIs are stable across upgrades and should be preferred over custom services.
━━━━━━━━━━━━━━━━━━━━
▶ 2. ODATA ADAPTER
The OData receiver adapter lets you select the service, entity set and operation using the service metadata, generating the query or payload structure. It handles CSRF tokens for modifying operations and supports $batch for multiple changes.
━━━━━━━━━━━━━━━━━━━━
▶ 3. READING LARGE DATA
Reading thousands of entries needs paging with $top and $skip or server-driven paging. The adapter's paging options and looping process calls help process large volumes without memory issues.
━━━━━━━━━━━━━━━━━━━━
▶ 4. ACCESS SETUP
In S/4HANA Cloud, communication scenarios, communication systems and arrangements grant API access to a communication user. On-premise, the OData services must be activated and the technical user needs the related authorizations. Least privilege applies.
━━━━━━━━━━━━━━━━━━━━
▶ 5. ERROR HANDLING
OData errors return structured messages; map them into exception handling and alerts. For create operations, design idempotency, for example by checking for existing records using a business key before creating.
━━━━━━━━━━━━━━━━━━━━
▶ STEP BY STEP
- Find the Business Partner API on SAP Business Accelerator Hub.
- Configure an OData receiver adapter to query partners.
- Add paging for a large read.
- Create a record and handle an error response.
✅ CHECKPOINT: an iFlow reads and writes S/4HANA data through a released API with paging and error handling.
How the SAP process fits together
SAP PROCESS EXPLORER · Integration: sender to receiver
ERPClimb.comProxy, SOAP and OData Integration — process breakdown
Topic-specific conceptual flow: how key objects and decisions fit together. SAP configurations and exceptional cases can follow different paths.
Selected process stage
Choose
Pick ABAP proxy, SOAP service or released OData API
What this specific lesson teaches
Call S/4HANA APIs from the SAP Business Accelerator Hub with the OData receiver adapter: discovering APIs, query and create operations, CSRF and batch handling, paging large reads and authorizations for communication users.
Key lesson principle: S/4HANA publishes released APIs (OData, SOAP) documented on SAP Business Accelerator Hub.
Representative SAP learning flow, not a guarantee of system runtime sequence in every scenario. The chapter-specific facts come from the published lesson text.
Real project scenario
An interface created duplicate business partners whenever a retry happened after a timeout. Adding a query on an external ID before creation, and treating 'already exists' as success, made the integration idempotent.
Common mistakes
- Custom services instead of released APIs.
- Reading without paging.
- Over-privileged communication users.
- Non-idempotent creates.
Best practices
- Released APIs from the Business Accelerator Hub.
- Paging for large reads.
- Least-privilege communication users.
- Idempotent create logic.
Interview angle
Interviewers ask how to integrate with S/4HANA APIs from Cloud Integration, how access is configured and how large reads and retries are handled.
Practice this lesson
Original educational case studies for SAP consultants, not official SAP certification exam questions. Verify product edition and implementation details against the current SAP documentation.
Quick check
0 of 3 questions attempted
1. Where are released S/4HANA APIs documented?
2. What grants API access in S/4HANA Cloud?
3. How do you avoid duplicates when a create call is retried?
Interview questions
1. How would you integrate a third-party system with S/4HANA business partners via Cloud Integration?
Answer it in your own words first, then compare.
Check before use: lesson examples are educational, not a guarantee of correctness for your SAP edition or release. Sample code has not been executed on your SAP system. Confirm API availability, syntax, authorizations and business impact in an approved development or test environment.