Software buyer preparation

How to Prepare Your Systems for an Integration Project

Prepare an integration project by confirming system owners, permitted operations, test access and the meaning of the data being exchanged. Prove one representative transaction and its failure path before committing to a wider rollout.

Need a partner to connect the systems?

Explore LCR’s systems integration and workflow service to agree the system map, ownership decisions, exception handling and first pilot. Specific interfaces and delivery scope need verification before committing to the build.

Name the systems and the people who control them

An integration project connects business actions and records, not only endpoints. Begin with the source and destination of one useful transaction. Identify the business owner who defines its meaning, the technical owner who can approve access and the person responsible when it fails.

Record the product, deployment context, relevant interface documentation and existing integrations. Ask whether a supplier must enable access or approve a new use. An API advertised online does not prove that your account, licence or installation supports the required operation.

This guide concerns preparation before development. Use the portal integration guide or integration layer guide for the resulting design choices.

Write down the transaction contract

For each record or action, capture its identifier, required fields, allowed values, owner and expected result. Explain units, time zones, status meanings and how corrected or deleted records are represented. Include the refresh requirement and the consequence of delayed information.

  • Which system may create or change the authoritative record?
  • How is the same entity recognised in both systems?
  • What constitutes acceptance, rejection or work still pending?
  • What prevents a retry from creating an unintended duplicate?
  • Who resolves mismatches rather than silently overwriting them?

A successful connection test answers only whether access works. It does not prove that both teams interpret the exchanged data in the same way.

Prepare controlled access and representative data

Agree separate test access, the minimum permissions needed and how credentials are issued, stored, rotated and revoked. Do not paste production secrets into a brief or shared sample file. Ask the system owner what can safely be exercised in a sandbox and where its behaviour differs from production.

OWASP's REST security guidance calls for HTTPS and endpoint access control, and warns against putting credentials in URLs. Those controls are part of the preparation, not a substitute for reviewing the complete integration.

Use synthetic or appropriately sanitised records that preserve important edge cases. Agree authorised access, retention and deletion for any necessary real data. Include missing values, historical statuses and corrected identifiers, not only a perfect demonstration record.

Agree failure behaviour before the first write

Ask what happens when a request times out after the receiving system has accepted it. Define a way to check the existing outcome before repeating a consequential operation. Also plan for unavailable dependencies, permission expiry, rate limits and records that fail validation.

Hypothetical example: a portal submits a service request to an operational system. The response is lost. Staff should be able to find the original request by its correlation reference before deciding whether it needs resubmission. A timeout should not automatically create another job.

Record the recovery owner, visibility needed in logs and the conditions for manual intervention. Keep sensitive payloads out of routine diagnostic messages unless their storage is necessary, authorised and protected.

Use a readiness decision, not a completed checklist alone

Before build planning, review the available evidence: a named owner, confirmed operation, test access, representative records and an agreed failure path. Identify what is proven, what remains assumed and the next test needed. If access is unavailable, estimate that uncertainty explicitly rather than hiding it.

Pilot the smallest complete transaction. Reconcile what was sent, accepted and applied, then check the business result with the owner. Agree how release changes are controlled and how a failed cutover is recovered.

Bring the evidence to a discovery discussion and include dependencies in the delivery scope. Price and timing should follow the verified work, not the number of systems in a diagram.

Sources and review date

Primary guidance reviewed on 9 September 2026 is linked beside the claims it supports. Checklists and examples are planning aids, not measured research or client results. Examples are hypothetical. Confirm delivery scope, estimates and any specialist-review needs with the responsible team.

Questions

Frequently asked questions

Is API documentation enough to start?

No. Confirm access to the required operations, system-owner approval, data meanings, test behaviour and recovery responsibilities.

Should developers use production credentials for a demonstration?

Prefer controlled test access. Any necessary production access must be explicitly authorised, limited and handled through an approved secure process.

Prepare a useful conversation

Bring the task and the unanswered questions.

Discuss the current workflow, source systems and first useful outcome with LCR Technologies.