ACS API overview
App Connector Service REST surface (/acs) mapped to DIP features and Swagger
Base path
App Connector Service mounts with globalPrefix: /acs. All routes below are relative to that prefix (for example GET /acs/apps).
Interactive docs: /acs/swagger-api (Swagger UI title: App Connector Service API Documentation).
Operators should use the deployed ingress URL for their environment (staging/production) plus /acs/swagger-api; exact hosts are managed outside this repo.
Controllers and DIP features
| Controller prefix | DIP / product area |
|---|---|
/apps | Apps list, create, update, public-app configuration, inbound auth setup, dashboards. |
/events | Events per app (inbound/outbound), overview lists for filters. |
/connectors | Connectors between apps; create wizard backing APIs. |
/connector-events | Connector–event mappings CRUD, task CRUD, bulk task operations. |
/templates | Template Master CRUD and preview (see Template Master). |
/analytics | Event/job listings, dashboards — query DTOs such as EventJobQueryDto (filters for apps, events, connectors, status, dates). |
/common | Shared utilities — includes POST /acs/common/seed (JSON seeders from the seeders disk) and POST /acs/common/sync-public-events (propagate public events to enterprise apps). See Seeding and sync public events. |
/enterprise | Enterprise-scoped operations. |
/session / /user | Auth session and user profile for the console. |
/health | Liveness/readiness style checks. |
DTO highlights
- Apps:
CreateAppDto,UpdateAppDto,AppQueryDto, inbound/outbound auth payloads indto/app.ts. - Connector events:
CreateConnectorEventDto,CreateTaskDto,TaskConfigDto— authoritative validation for task configs (Task types reference). - Analytics:
EventJobQueryDto— matches event log grid filters (Event log and jobs).
Relationship to runtime ingress
ACS configures Mongo documents that ingress and egress read at runtime. Changing mappings or tasks through ACS affects future inbound requests, not past jobs (unless you retry jobs).
Related
- Data model reference — persisted fields.
- Ingress / Egress — execution path.