External API Integration Service
Component Detail
Description
Core orchestration service that manages all outbound integration calls to external systems. Routes requests to the appropriate adapter based on integration type, handles authentication token refresh, schedules sync jobs, and processes inbound webhook events from supported external systems.
external-api-integration-service
Responsibilities
- Route integration requests to the correct adapter implementation
- Manage OAuth2 token lifecycle for Dynamics and other OAuth-based systems
- Schedule and trigger periodic data synchronization jobs
- Process inbound webhook events from external systems
- Emit integration result events for downstream consumers
Interfaces
triggerSync(organizationId, integrationType)
processWebhookEvent(source, payload)
getIntegrationStatus(organizationId, integrationType)
scheduleSync(organizationId, integrationType, schedule)
cancelScheduledSync(organizationId, integrationType)
exportReimbursements(organizationId, reimbursementIds)
syncMembershipData(organizationId)
syncCourseEnrollments(organizationId)
refreshOAuthToken(integrationId)
getLastSyncResult(organizationId, integrationType)
Relationships
Dependencies (2)
Components this component depends on
Sub-Components (4)
Adapter implementing IntegrationAdapter interface for HLF's Dynamics 365 portal. Handles OAuth2 authentication against Dynamics 365 REST API and performs bidirectional user and membership data synchronization.
- Authenticate via OAuth2 against Dynamics 365
- Sync user and membership records with HLF portal
- Map Dynamics entity schema to internal data models
Adapter for Blindeforbundet's Xledger accounting system. Exports approved reimbursement records to Xledger via SOAP or REST API after approval workflow completion, eliminating manual data re-entry.
- Authenticate with Xledger API
- Export approved reimbursement records as accounting entries
- Handle SOAP or REST protocol negotiation
Adapter for Cornerstone learning management system integration. Synchronizes course enrollment data between the platform and Cornerstone, falling back to CSV export if direct API access is unavailable.
- Sync course enrollment records with Cornerstone
- Generate CSV export as fallback when API unavailable
- Map internal course entities to Cornerstone schema
Adapter for Consio integration. Provides data exchange with Consio using available API or CSV export as initial implementation, following the same IntegrationAdapter interface as other adapters.
- Authenticate with Consio system
- Export relevant data records to Consio
- Provide CSV fallback if API is unavailable