System Integration Planning: APIs, Data and Ownership

Sigue un intercambio de principio a fin.

Elija un intercambio representativo, como un pedido que se traslada de un sitio web a una aplicación interna. Enumere el sistema de envío, el sistema de recepción, los campos y el activador. Decida qué sistema posee cada valor. Si dos sistemas pueden actualizar el mismo registro, documente cómo se manejarán las actualizaciones conflictivas antes de crear la interfaz.

Diseño para mensajes retrasados ​​y repetidos.

Una integración puede recibir la misma solicitud dos veces o perder una respuesta después de que el receptor haya completado su trabajo. Analice los identificadores, los reintentos y la conciliación con el equipo de implementación. Defina cómo ven los usuarios un intercambio pendiente o fallido y quién puede corregirlo de forma segura sin crear registros comerciales duplicados.

Hacer que la interfaz sea revisable.

Registre ejemplos de entradas aceptadas y rechazadas, respuestas esperadas y requisitos de acceso. Incluya un proceso de cambio para que un sistema no pueda romper silenciosamente al otro. Revise el contrato con ambos propietarios y pruebe las fallas de los representantes antes de considerar la integración lista para su uso operativo.

Walk through the life of an exchanged record

Choose one record, such as an order, and follow its creation, update, cancellation and correction. At every boundary, identify the sending system, receiving system and source of truth. Confirm the actual interface available rather than assuming that an application exposes the data you need.

Review authentication, field meanings, identifiers and expected timing with both owners. Test a duplicate message, a delayed update and an unavailable destination. Decide how to distinguish a rejected request from an uncertain outcome. Arrange reconciliation so the operating team can find records that disagree after an interruption. These decisions should be captured before implementation begins.

An interface contract planning sheet

This is a discussion template, not a substitute for the technical contract. Attach the relevant API specification or file format after the owners agree the behaviour.

• Purpose and direction: why the exchange occurs and which system initiates it.
• Record identity: stable identifiers, field definitions and ownership of each value.
• Trigger and timing: event, schedule, expected delay and ordering assumptions.
• Access and limits: authentication, permissions and constraints confirmed by the provider.
• Failure handling: timeouts, duplicates, retries, rejection reasons and human escalation.
• Verification: test examples, reconciliation checks, versioning and named support owners.

Do not equate a response with a completed business action

A successful technical response may acknowledge receipt without confirming that a downstream process finished. Agree what each status means and how completion is checked. Conversely, a timeout may leave an uncertain result, so retrying a consequential action without checking can create duplication.

Avoid relying on field names alone. Two systems may use the same label for different concepts. Keep mappings and interface changes visible to both teams, including who approves a breaking change.

Should an integration be real time?

Choose timing around the business need and the capabilities of the connected systems. A scheduled exchange may be sufficient for some tasks; others need an event-driven flow. Document the acceptable delay and recovery approach before choosing the implementation pattern.

ILLUSTRATIVE PLANNING EXAMPLE

Example: connecting orders and inventory

An order system sends confirmed purchases to inventory. Decide which system owns stock counts, when a reservation occurs and how cancellations reverse it. Ask what happens when the same message arrives twice or inventory is temporarily unavailable. Assign an owner to each interface and agree representative integration tests.

Create an interface sheet covering fields, triggers, permissions, duplicate handling and recovery. Confirm assumptions with both system owners before estimating the connection.

FURTHER READING

Official resources to explore

Explore the related official guidance below. The templates and examples are practical starting points to adapt to your own project.

• MDN: overview of HTTP