ON THIS PAGE
Start with a business operation
A custom broker integration should implement a defined operation: creating accounts from a client area, distributing prices to a consumer, updating operational status or reconciling platform records. Describe the trigger, expected result and the systems involved. This makes the work testable without assuming a particular transport or vendor before requirements are known.
Agree an interface contract
Document identifiers, required fields, units, authentication, permissions and error responses. Define who owns each field and whether a change is synchronous or processed later. If third-party interfaces are involved, confirm access and permitted use before committing to implementation.
Design for incomplete outcomes
A network error does not establish that the requested operation failed. Use correlation identifiers, idempotency where applicable and a way to query the recorded outcome. Queued work needs visible pending and failed states. Retrying an administrative operation should follow its semantics rather than a blanket resend policy.
Acceptance belongs at both ends
Test the caller and receiving system together with normal, invalid and repeated requests. Include authentication failure, unavailable dependencies and recovery after interruption. Verify that logs support investigation without unnecessarily exposing credentials or client information.
Deliver maintenance information
A handover should describe the supported interface version, deployment configuration, secret rotation, monitoring and recovery procedure. Identify who reviews changes from upstream vendors. For an initial assessment, share sample non-sensitive payloads, expected volume, current platforms and the workflow to automate.