The increasingly complex multi-partner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing.
In order to meet these challenges, TM Forum members including the world’s largest service providers and suppliers, have been working to develop APIs that enable the open digital ecosystem and provide critical management functionality to digital services.
This table contains links to both Release and Beta versions of the Open APIs.
By default, the information in the table is sorted by API title, but can be re-sorted (for example, by Document Number or Release Version) by clicking on the relevant column headings.
Please note that Comments are no longer permitted on this page. If you have any questions regarding the content of the Open API Table please post them as discussion topics on the Open API Community Forum.
To access the API table links below you will need to be logged in
TM Forum Open APIs
TM Forum Open APIs _____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API Specification (RAND) | Conformance Profile (RAND) | CTK | Reference Implementation Code | Postman Collection | Release | Lifecycle Status |
---|---|---|---|---|---|---|---|---|---|
Activation and Configuration API The REST API for Activation and Configuration allows the user to retrieve, create, update, delete services and retrieve the monitor resource used to monitor the execution of asynchronous requests on a specific resource. Although all the examples given in the API specification are relative to Services, the same API can be used to Activate and Configure Services or Resources. | TMF640 | Not yet available | Not yet available | 15.5.1 | |||||
Service Catalog API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 | Not yet available | Not yet available | Not yet available | 17.5.0 | ||||
Service Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | TMF638 | R18.0 Refresh in progress | R18.0 Refresh in progress | R18.0 Refresh in progress | 18.0.1 | Updated | |||
Service Ordering Management API The REST API for Service Order Management provides a standardized mechanism for placing a service order with all of the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications. | TMF641 | R18.0 Refresh in progress | R18.0 Refresh in progress | R18.0 Refresh in progress | 18.0.1 | Updated | |||
Service Qualification API Service Qualification API is one of the Pre-Ordering Management APIs. Service Qualification API goal is to provide service availability at Customer location. | TMF645 | R18.0 Refresh in progress | R18.0 Refresh in progress | R18.0 Refresh in progress
| 18.0.1 | Updated | |||
Service Quality Management API Through this API, any Enterprise is able to access a Service Quality Management application and extract Service Level Specifications and associated Service Level Objectives (SLO) and their thresholds. | TMF657 | R18.0 Refresh in progress | R18.0 Refresh in progress | R18.0 Refresh in progress | 18.0.0 | Updated | |||
Service Test Management API The Service Test API provides a standardized mechanism for placing a service test with all of the necessary test parameters. The API consists of a simple set of operations that interact with CRM/Service Management systems in a consistent manner. A service test is a procedure intended to check the quality, performance, or reliability of a service. | TMF653 | R18.0 Refresh in progress | R18.0 Refresh in progress | R18.0 Refresh in progress | 18.0.0 | Updated | |||
Usage Consumption Management API This API should allow viewing in real-time the balance of the various buckets (SMS, Voice, Data for example) that a user consumes with each of his devices and the usages done out of the bucket. A usage report retrieves the data related to these balances. This API should also allow performing a direct top-up on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfer. | TMF677 | Not yet available | Not yet available | Not yet available | 17.5.0 |