Integration Concepts
Summary: NEFE integrations should exchange the smallest reliable set of business events or records required for an approved journey.
#Conceptual patterns
| Pattern | Appropriate when | Key concern |
|---|---|---|
| File exchange | Bounded batch data is sufficient | Validation and replay |
| Operator-assisted import | Early pilot volumes are low | Auditability and human error |
| Service integration | Timely automated exchange is required | Authentication and resilience |
| Event notification | Downstream action follows a state change | Ordering and duplicate delivery |
These are architectural concepts, not implemented interface commitments.
#Event design
A well-defined event has:
- A business meaning and owner.
- A timestamp and stable identifier.
- A version.
- Permitted attributes.
- Documented duplicate or correction behavior.
Source system
→ validate and minimize
→ approved exchange boundary
→ NEFE workflow
→ outcome and operational monitoring
#Failure handling
Before launch, define:
- Timeouts and retries.
- Idempotency.
- Dead-letter handling and reconciliation.
- Customer impact.
- Escalation.
#Security
Never place secrets in:
- Source code.
- URLs.
- Logs.
- Documentation examples.
Confirm the deployment’s approved authentication and network controls during readiness review.
#Related pages
Continue to API readiness and privacy and data protection.