Integration Master Data Management (External)
Problem
Partner applications and SaaS platforms run by other organisations need to read and update the same customer, product and location records as internal workloads, in near real time. Their calls arrive over the Public Internet, so each partner must authenticate (OAuth 2.0 or mutual TLS) at a WAF-protected API Gateway in the perimeter before reaching the MDM platform. When that path is missing or unreliable, the copies drift and downstream decisions rest on stale or conflicting values.
Solution
Make a Master Data Management (MDM) platform the single source of truth for reference data. External systems read and update it through a managed API Gateway and receive changes from an event streaming platform. Outbound traffic leaves through an egress gateway limited to allow-listed FQDNs, so partners consume and contribute data under one set of security and governance rules.
Cloud Paradigm
- Data-as-a-Service (DaaS)
- Event-Driven Architecture
- API-Led Connectivity
- Centralised Data Governance
- Zero Trust Data Access
Solution Flow
Reference Data Consumption Flow (Inbound):
- External System Request: An external application or partner system sends a request (e.g., HTTPS GET/POST) to read or update a reference data entity.
- Edge Protection (WAF): At the public-facing cloud edge, a Web Application Firewall (WAF) checks for malicious signatures and applies preliminary rate limits.
- API Gateway: The API Gateway authenticates the external caller (e.g., OAuth 2.0, mTLS), terminates TLS, applies traffic policies (rate limiting, throttling) and routes the request to the MDM integration layer in a Private Subnet (Workloads).
- MDM Integration Layer: An integration microservice or MDM API endpoint validates the data, applies MDM business rules (e.g., survivorship) and calls the core MDM platform.
- MDM Core Platform: The Master Data Management system stores, updates or returns the authoritative reference data and enforces its quality and consistency.
Reference Data Distribution Flow (Outbound):
- MDM Event/Update: The MDM Core Platform detects a change to a critical reference data entity (e.g., new customer, updated product category), or an internal workload requests a data export.
- Event Streaming Platform / MDM Publisher: For real-time distribution, the MDM platform publishes the change event to a managed Event Streaming Platform (e.g., Kafka-compatible service). For batch or scheduled exports, an MDM publisher service prepares the data.
- Egress Gateway / Managed NAT: Event streams and API calls to external systems leave through a Managed NAT/Egress Gateway, which enforces outbound FQDN allow-listing, performs network address translation, and applies an egress Web Application Firewall (WAF) to calls to external APIs.
- External Target System: The external system (e.g., partner application, data warehouse, analytics platform) takes in the updates through its ingestion endpoint (e.g., webhook, API, SFTP via secure gateway).
When to Use
- An MDM platform is the authoritative source for critical reference entities (customer, product, location), and that data must go beyond your network boundary.
- External partners or SaaS applications both consume and contribute reference data, so flows run both ways and need survivorship and conflict resolution.
- Consistency must hold for real-time synchronous lookups and for near-real-time event propagation to many different consumers.
- Regulation or governance requires every external data exposure to be mediated, authenticated (OAuth 2.0/mTLS) and audited, with no direct data store access.
- You need synchronous query and update paths plus asynchronous change distribution from one governed platform.
When NOT to Use
- Reference data is small, static and rarely changes: a published static dataset or CDN-hosted file is simpler than a full MDM integration layer.
- Only internal services consume the data; a lighter internal shared-database or cache pattern avoids the API Gateway and egress overhead.
- No system is truly authoritative and several co-own the data equally: a peer-to-peer data mesh or reconciliation pattern fits better than a single-source-of-truth MDM.
- The need is bulk analytical replication with high latency tolerance, where an ETL/ELT pipeline into a warehouse costs less.
- Transactional business events (orders, payments), not reference data, drive the integration: use an event-choreography or saga pattern.
Trade-offs
- Single authoritative source with enforced data quality vs the cost of running and governing a dedicated MDM platform and its stewardship workflows.
- Strong security via mediated APIs and event streams vs added latency and infrastructure from WAF, API Gateway and egress NAT layers on every exchange.
- Real-time distribution through event streaming vs the complexity of idempotency, dead-letter queues and schema versioning across asynchronous consumers.
- Decoupled bidirectional integration vs maintaining versioned OpenAPI/AsyncAPI contracts and survivorship logic as entities change.
- End-to-end observability of the sync lifecycle vs the effort to instrument tracing and metrics across gateway, integration services and streaming tiers.
Illustrative Scenario
A hypothetical scenario showing how the pattern applies. Not a client case study.
In this hypothetical scenario, an automotive parts supplier network keeps its authoritative part numbers, supersession chains and supplier locations in a central MDM platform. Distributor and repair-shop portals call an OAuth 2.0-secured API Gateway to check part fitment and enrich SKU records. Their traffic passes a WAF first, then reaches the MDM integration microservice, which applies survivorship rules across competing catalogue sources.
When a manufacturer updates a supersession chain, the MDM core publishes the change to a Kafka-compatible stream. A warehouse inventory system and a tier-one supplier consume it through a webhook and secure ingestion endpoints. Outbound calls to partner ERPs go through a Managed NAT that enforces FQDN allow-listing. Dead-letter queues and idempotency keys mean a duplicated price or supersession update is never applied twice. Distributed tracing across the gateway, integration services and streaming tier covers the whole synchronisation lifecycle, so a stalled update can be traced to the hop where it stopped.
Additional Details
- MDM Style & Interfaces: The MDM style (e.g., Registry, Consolidation, Coexistence, Centralised) decides which integration patterns apply. Expose every interface, for querying, pushing or synchronising data, as a secure, versioned API or event stream.
- Data Quality & Governance: Keep data quality rules, stewardship workflows and survivorship logic in the MDM platform to resolve conflicts and protect data integrity.
- Error Handling & Idempotency: Give every integration point retries, dead-letter queues for asynchronous messages, and idempotency so no update is processed twice.
- Protocol & Format: Use REST/HTTPS for synchronous calls and event streams with structured formats (e.g., JSON, Avro) for asynchronous distribution. Standardise schema definitions (e.g., OpenAPI Specification, AsyncAPI) for every exchanged information object.
- Observability: Collect centralised logs, metrics (latency, throughput, error rates) and distributed traces (e.g., OpenTelemetry) across the API Gateway, MDM integration services and Event Streaming Platform to follow each synchronisation end to end.
- Security by Design: No direct database connections for external access; all data exposure goes through controlled API endpoints or secure event streams.
Security Controls
- Perimeter Security: Inbound connections to the MDM integration endpoints terminate at an Edge API Gateway in a Public Subnet (Perimeter), behind a Web Application Firewall (WAF) that blocks common attacks (e.g., OWASP Top 10) and malicious bot traffic. Outbound distribution passes through a secure Egress Gateway.
- Transport Security: Enforce TLS 1.2 or higher on all inbound and outbound endpoints; use mTLS for highly sensitive system-to-system integrations.
- Authentication & Authorisation:
- Authenticate system-to-system (B2B) consumers with OAuth 2.0 (Client Credentials Grant) or Mutual TLS (mTLS).
- Authenticate external users or client applications with OAuth 2.0/OpenID Connect (OIDC).
- Apply granular authorisation policies based on data access roles in the MDM system.
- Traffic Management: Use API Management policies for rate limits, throttling and burst quotas, protecting the MDM backend from DDoS attacks and accidental traffic spikes.
- Outbound Controls: Configure the Egress Gateway to permit outbound connections only to listed external IP addresses or fully qualified domain names (FQDNs). Inspect outbound data for Data Loss Prevention (DLP) where compliance and data sensitivity require it.
- Data Encryption: Encrypt sensitive reference data at rest in the MDM platform and in transit.
Related Patterns
Use and cite this
Free to use and adapt under CC BY 4.0. Credit: David Tirabassi, IT Architecture Patterns.
Attribution: Source: David Tirabassi, IT Architecture Patterns (https://www.itarchitecturepatterns.net/patterns/int-mdm-external), licensed under CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).