This template is designed to guide integration architects and developers in documenting all required information for an interface. Each section includes a short explanation (tooltip) and example values to clarify usage.

Lifecycle & Changes

Historical context and milestones.

Status	Active
Created	2025-01-01
Updated	2025-05-01 – linked to O2C

Integration Description

What is this interface about? Who uses it and for what purpose?

Summary

Example: This integration synchronises planned orders data from Kinaxis Maestro to SAP ECC.

Use Case Reference

Example: Project Sunrise - Use Case: Customer Creation

Overview

Basic metadata and lifecycle of the interface.

Smart ID/Legacy IDs	SUPPLYCHAIN-MAESTRO-ECC-PLANNEDORDER-V1
Artefact(s)	Integration Flow(s) Global Kinaxis Receive Kinaxis Webhook Process Kinaxis Webhook API Proxy(ies) KinaxisWebHook_v1
LeanIX Fact Sheet(s)	Maestro APS to SAP ERP PF2 Maestro APS to SAP ERP WP2
Service Pool / Process / Domain	Production Data
Integration Style	API-Managed Integration
Data Volume
Frequency	Batch running on Kinaxis Maestro (3 times a day)
Source System	Kinaxis Maestro APS
Source Protocol	REST
Source Data Format	JSON
Source Authentication mechanism	Oauth 2.0
Target System	SAP PF2 or WP2
Target Protocol	RFC
Target Data Format	XML
Target Authentication mechanism	Basic Authentication
SLA	Go to Source and Target Application in LeanIX and look at Business Criticality and Functional Fit section
Version	Increment for significant logic changes, for example, V1

Functional Requirements & Rules

Business rules and conditions.

Mandatory field SalesOrg must be present
Convert CustomerCategory to AccountType
Enrich RegionCode from mapping table

Integration Flow

receive a webhook from Kinaxis Maestro APS
Get file data by calling POST workbook API
generate the csv file
route to the PF2 or WP2 SFTP server based on the end the file name (if the file name ends by WP → WP2, if the file name ends by PF → PF2)

Technical Components Involved

Detailed list of systems and middleware used.

Component Type	Name / Detail	Role / Description
Integration Flow	`CPI iflow-customer-sync-v1`	Executes logic
API Management	`SAP ISAM Proxy`	Secures and routes requests
Event System	`SAP Event Mesh`	Publishes asynchronous events
File Gateway	`B2B MFT Adapter`	For batch file interfaces
Monitoring	`Cloud ALM, Grafana`	Monitoring tools

Integration Design

Core interface behaviour and configuration.

Attribute	Description	Example
Direction	Data flow orientation	`Inbound`, `Outbound`, `Both - to be discussed with Owen`
Versioning Strategy	How interface versioning is managed	`URI`, `Header`, `SmartID`

Transformation

Link to Mapping Spreadsheet

Security & Access Control

Per-component security model.

Component	Authentication	Transport Security	Authorization	Notes
SAP S/4HANA	`Client Certificate`	`TLS 1.2`	`SAP Roles`	Cloud Connector
CPI	`OAuth2`	`N/A`	`Internal Only`	Managed by tenant
Salesforce	`OAuth2`	`HTTPS`	`Token Scopes`	Dedicated user

Error & Exception Handling

Resilience and error management.

Retry Logic	3x every 30s, exponential backoff
Dead Letter Queue	Enabled, Not Applicable
Alerting	Email, Cloud ALM, PagerDuty
Error Logging	CPI Logs, Splunk, Monitoring Platform

Monitoring & Runbook

How is the interface observed and troubleshooted.

Monitoring Tool	SAP Cloud ALM, Grafana, Elastic
Runbook Location	[Runbook PDF](#)
Dashboard URL	[Grafana Dashboard](#)

Other Artefacts

Implementation assets.

Artefact	Notes
Git Repository
API Specification	Please refer to API Reference tab
Test Results