Interface Contract Block
Document API and service interface contracts with operations, data types, constraints, and SLAs. Define clear agreements between service providers and consumers.
The Interface Contract block documents agreements between service providers and consumers. It captures the contract name, integration type, operations, data types, constraints, and service level agreements.
When to Use
Block Properties
Operation Properties
Integration Type Values
Example: Synchronous REST API Contract
A standard REST API contract for order management.
Example: Asynchronous Message Contract
An async contract for payment processing.
Example: Batch Integration Contract
A batch file transfer contract for reporting.