Introduction to tSM Public API (v2)
The tSM Public API v2 is the standardized, external-facing interface to the core modules of the tSM platform. Each module is implemented as a microservice exposing a consistent set of REST operations, enabling external systems (CRM, portals, provisioning systems, etc.) to interact with tSM in a controlled and modular manner.
While the core modules provide a fixed set of entity APIs out of the box, additional endpoints or extensions may be exposed depending on individual customer implementations. Moreover, when needed, tSM Public APIs can also be delivered in a TM Forum–compliant variant to better align with industry integration standards.
Below is a high-level overview of the core modules and APIs, followed by a short summary of each.
Core Modules (Public APIs) of tSM
In a standard tSM deployment, the following public API modules are typically exposed:
| Module / Domain | Purpose & Responsibilities |
|---|---|
| User / Identity | Manage user accounts, roles, groups, permissions, and identity metadata. |
| Customer / CRM | Handle customer records, contacts, accounts, status, and relationships. |
| Ticket / Service Request | For incident, service request, maintenance, change management workflows. |
| Catalog / Product | Definition and management of product and service catalogs, features, price plans. |
| Inventory / Resource | Tracking and management of network or system resources (devices, ports, circuits). |
| Process / Workflow | Start processes, query tasks, advance workflow states, integrate BPMN orchestration. |
| Configuration / Settings | System-level configuration objects, lookup tables, register values. |
| DMS / Document Management | Manage documents, file storage, versioning, attachments. |
Note: The actual list of exposed modules may vary per deployment or customer. Custom or partner-specific modules may also be exposed through the Public API.
Summary of Each Core API
Below is a short summary of each module’s typical capabilities and use cases.
| Module | Typical APIs / Entities | Use Cases |
|---|---|---|
| User / Identity | /users, /roles, /groups, /regions | Authentication, access control, user provisioning |
| Customer / CRM | /customers, /persons, /accounts | Customer master data, contact records, segmentation |
| Ticket / Service Request | /tickets, /ticket-types, /SLA | Logging incidents, managing service requests, tracking SLA status |
| Catalog / Product | /product-catalogs, /offerings, /attributes | Exposing product/service definitions to frontend or order systems |
| Inventory / Resource | /resources, /devices, /ports, /circuits | Inventory discovery, allocation, capacity management |
| Process / Workflow | /processes, /tasks, /actions | Triggering business workflows, monitoring statuses, advancing state |
| Configuration / Settings | /register-values, /settings, /conversion-configs | Lookup data, business logic configuration, system metadata |
| DMS / Document Management | /documents, /attachments, /versions | File uploads, version history, linking docs to entities |
Each of these modules follows the same set of REST operations (CRUD, bulk, search, page) and filter/expand semantics, which ensures that once you understand one, you can work with them all.
Extensibility & Customization
-
Custom Endpoints per Customer In many customer-specific deployments, additional endpoints may be added beyond the standard set — for example, domain-specific queries or actions. These custom endpoints follow the same conventions (HTTP verbs, headers, error format) to maintain consistency.
-
TM Forum Standard Option Where required by integration architecture or industry practices, tSM Public APIs can be delivered or adapted to TM Forum–compliant interfaces. This enables smoother interworking with other systems or services that expect TMF-style APIs or data models.