SureInk Platform Documentation
Welcome to the official documentation for the SureInk Platform (SureMSA). This platform is a robust microservices-based system designed for managing Master Subscription Agreements (MSA), licenses, and third-party integrations.
How this document is organized
To help you navigate the platform's complexity, this documentation is organized into three functional tiers that separate business logic from technical foundation:
- Business Services: Focuses on the "What". These are domain-specific microservices that handle the core business logic, such as licensing, customer management, and subscription rules.
- Platform Services: Focuses on the "How". These are the "glue" services that provide orchestration, routing, and shared utilities, enabling the business services to function as a unified platform.
- Infrastructure & DevOps: Focuses on the "Where". This covers the technical foundation, including databases, messaging systems, identity management, and containerization strategies.
Business Services
Explore the domain-specific logic and functional details of our core services:
- Business Services: The heart of licensing and subscription logic.
- Connector: The bridge to third-party integrations (Salesforce, Stripe, etc.).
- Customer Service: Source of truth for all customer profiles.
- User Management: IAM and organizational structure.
- Usage Data: Tracking and compliance metrics.
Platform Services
Details on the orchestration and cross-cutting concerns of the platform:
- API Gateway: Central entry point, routing, and security.
- Discovery Server: Service registry and network location discovery.
- Service Manager: Platform orchestration and service lifecycle management.
- Platform Utilities: Shared platform-level services and helper functions.
Infrastructure & DevOps
The technical foundation and environment configuration:
- Architecture Overview: High-level system diagrams and component relationships.
- Infrastructure Components: Details on Keycloak (IAM), PostgreSQL (DB), and Kafka (Messaging).
- Docker & Deployment: Containerization and environment orchestration.
Frontend
- Angular UI: Documentation for the SureMSA Web Application.