INTEGRATION · DECISION GUIDE · V1.0.0

Choosing API, event or batch integration.

Pick an integration style based on interaction semantics, consistency, latency and recovery—not because a platform supports a particular technology.

REFERENCE FIGURE / NR-007CONCEPTUAL VIEW · NOT A DEPLOYMENT TOPOLOGY
Choosing API, event or batch integration. Pick an integration style based on interaction semantics, consistency, latency and recovery—not because a platform supports a particular technology.
nishantr · nishantr.techOpen full-size figure ↗
THE PROBLEM

Why this pattern exists

Teams frequently use synchronous APIs for loosely coupled broadcasts, events for commands, or batch for workloads that require transactional feedback.

DESIGN GUIDANCE

Principles to preserve

  1. Need a response now? Prefer a synchronous API or request/reply contract.
  2. Publishing a completed fact to many consumers? Prefer a domain event with durable delivery.
  3. Moving large datasets on a tolerance window? Consider batch or CDC.
  4. All patterns need identity, schema versioning, retries, dead-letter handling where relevant, observability and ownership.
  5. Model hybrid flows explicitly: command via API, event after commit, analytics via CDC.
THE REAL DESIGN WORK

Trade-offs, not just boxes

  • Synchronous calls offer immediate feedback but introduce temporal coupling.
  • Events support decoupling but demand idempotency and eventual-consistency design.
  • Batch is efficient for volume but trades freshness and granular failure handling.
REVIEW QUESTIONS

Before you implement

  • Is this a command, query, notification or bulk movement?
  • Which party owns successful completion?
  • What ordering, duplication and consistency guarantees are needed?
  • What happens when the receiver is down for six hours?
MORE FROM THE COLLECTION
NR-001Agent-ready SaaS: capability-centred reference architectureNR-005Enterprise data platform: trusted consumption architecture
← Back to all patterns