API
An API defines a structured way to exchange data or request an operation between systems. In a programme, it can link purchases, eligibility, points, or orders. The contract, authentication, errors, limits, and rework must be documented to make the integration usable.
A concrete example
An API can receive a validated order and return its processing ID. A unique ID prevents the same transaction from being credited twice.
A point to consider
Simply covering the nominal case is insufficient. Document authentication, duplicates, errors, retries, and frequency limits.
Prepare a contract that can be used by both teams
For each exchange, provide an accepted example, a rejected example, the required fields, and the resumption rules. Define a correlation identifier to trace a transaction between systems. Test an interruption after processing but before receiving the response: the resumption must retrieve the result without creating a second credit. Also, plan for tracking rejections and ensuring version compatibility.
Questions to ask your team
- Can we determine if a transaction was processed after an outage?
- Are temporary errors and invalid data handled differently?

