How isacna/ixc-soft-api works
Project Type: This is a TypeScript-based API wrapper/client library that provides a simplified interface for interacting with the IXC Soft ERP system.
Core Library Components
• Three main service sub-components:
• Authentication Service (auth.ts)
• Service (list.ts)
• Filter Service (concatenatedFilter.ts)
External Systems
• IXC Soft ERP System (as an external service)
• Client Applications (that will use this library)
Data Flow Components
• Authentication flow (Basic Auth/Token)
• API requests/responses
• Data transformation layers
[Client Applications]
• ↓
[API-IXC-SOFT Client]
• ↙ ↓ ↘
[Auth] [List] [Filter]
• ↓
[IXC Soft ERP]
Component Details
a. Client Applications (Top):
• As external systems that consume the library
• Configuration input (URL, credentials)
b. API-IXC-SOFT Client (Center):
• As the main interface layer
• TypeScript type definitions (@types)
• Service organization
c. Services (Middle):
• Auth Service: Show authentication handling
• Service: Show query operations
• Filter Service: Show filter processing
d. IXC Soft ERP (Bottom):
• As the target system
• API endpoints interaction
Important Flows to Highlight
• Configuration flow: Client → Library
• Authentication flow: Library → Auth Service → ERP
• Query flow: Client → List Service → ERP
• Filter processing: List Service ↔ Filter Service
Additional Elements
• Component types (services, external systems)
b. Notes for:
• TypeScript type definitions
• Authentication methods (Token/Username-Password)
• Query parameter formatting
Technical Details
• TypeScript integration
• Async/await operations
• HTTP/HTTPS communication points
Level of Detail:
• Authentication flow
• Query processing
• Filter concatenation logic
The flexible authentication options
Remember to:
• Use standard UML or C4 model notation where appropriate
• Version information
• Clear boundaries between components
• Error handling paths
• Public interfaces