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.
...
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.
...
...
| title | To access the API table links below you will need to be logged in |
|---|
To login with your TM Forum account please click on the Login button below
| Button Hyperlink |
|---|
| title | Login |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable |
|---|
|
Don't have an account? You can register by clicking here:
...
...
| Dialog |
|---|
| id | login-required |
|---|
| title | Login Required |
|---|
|
| Section |
|---|
| Panel |
|---|
| To access the API documentation you need to be logged in to your TM Forum account | Button Hyperlink |
|---|
| title | Login |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable |
|---|
|
Don't have an account? You can register by clicking here: | Button Hyperlink |
|---|
| title | Register |
|---|
| type | primary |
|---|
| url | https://www.tmforum.org/user-registration/ |
|---|
| target | true |
|---|
|
|
|
|
| Dialog |
|---|
| id | members-only |
|---|
| title | For TM Forum Members |
|---|
|
| Section |
|---|
| Panel |
|---|
|  Image Removed Thank you for your interest in this Early Adopter API.
We're sorry but the documentation is available to members only.
As a non-member, you are welcome to browse our Released TM Forum Open API documentation | Button Hyperlink |
|---|
| title | Browse Released APIs |
|---|
| type | primary |
|---|
| url | https://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs |
|---|
|
| Button Hyperlink |
|---|
| title | Find out more about Membership |
|---|
| type | standard |
|---|
| url | https://www.tmforum.org/membership/benefits/ |
|---|
| target | true |
|---|
|
|
|
|
TM Forum Open APIs
...
| sparkName | Sparkline |
|---|
| datepattern | yy-mm-dd |
|---|
| id | 1531953346851_-1199396180 |
|---|
| sort | Released TM Forum Open APIs (Asc) |
|---|
| isOR | AND |
|---|
| separator | Point (.) |
|---|
...
TM Forum Open APIs
_____________________________________
...
Swagger
(Apache 2.0 or RAND)
...
API Specification
(RAND)
...
Conformance Profile
(RAND)
...
Reference Implementation Code
...
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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/serviceActivationAndConfiguration/v2/swagger2.json |
|---|
| Name | Activation and Configuration API |
|---|
| |
|
| Show If |
|---|
|
 Image Removed
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84580852/TMF640_Activation_Configuration_API_REST_Specification_R15.5.1.pdf?api=v2 |
|---|
| Name | Activation and Configuration API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSSERVICEACTIVATION |
|---|
| Name | Activation and Configuration API |
|---|
| |
|
| Show If |
|---|
|
 Image Removed
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSSERVICEACTIVATION/blob/master/TMF%252520ActivationandConfiguration%252520API.json.postman_collection |
|---|
| Name | Activation and Configuration API |
|---|
| |
|
| Show If |
|---|
|
 Image Removed
|
...
Service Catalog API
The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF633_ServiceCatalog |
|---|
| Name | Service Catalog Management API |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514846/TMF633_Service_Catalog_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Service Catalog Management API |
|---|
| |
|
...
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514846/TMF633B_Service_Catalog_Management_API_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Service Catalog Management API |
|---|
| |
|
...
Service Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF638_ServiceInventory |
|---|
| Name | Service Inventory Management API |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570236/TMF638_Service_Inventory_API_REST_Specification_R18.0.1.pdf?api=v2 |
|---|
| Name | Service Inventory Management API |
|---|
| |
|
...
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570236/TMF638B_Service_Inventory_Conformance_Profile_R18.0.1.pdf?api=v2 |
|---|
| Name | Service Inventory Management API |
|---|
| |
|
...
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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF641_ServiceOrder |
|---|
| Name | Service Ordering Management API |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570242/TMF641_Service_Ordering_API_REST_Specification_R18.0.1.pdf?api=v2 |
|---|
| Name | Service Ordering Management API |
|---|
| |
|
...
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570242/TMF641B_Service_Ordering_Conformance_Profile_R18.0.1.pdf?api=v2 |
|---|
| Name | Service Ordering Management API |
|---|
| |
|
...
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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF645_ServiceQualification |
|---|
| Name | Service Qualification API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570247/TMF645_Service_Qualification_Management_API_R18.0.1.pdf?api=v2 |
|---|
| Name | Service Qualification API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570247/TMF645B_Service_Qualification_Conformance_R18.0.1.pdf?api=v2 |
|---|
| Name | Service Qualification API |
|---|
| |
|
...
R18.0 Refresh in progress
...
R18.0 Refresh in progress
...
R18.0 Refresh in progress
...
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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF657_ServiceQualityManagement |
|---|
| Name | Service Quality Management API |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570274/TMF657_Service_Quality_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Service Quality Management API |
|---|
| |
|
...
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570274/TMF657B_Service_Quality_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Service Quality Management API |
|---|
| |
|
...
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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF653_ServiceTestManagement |
|---|
| Name | Service Test Management API |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570262/TMF653_Service_Test_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Service Test Management API |
|---|
| |
|
...
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570262/TMF653B_Service_Test_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Service Test Management API |
|---|
| |
|
...
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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF677_UsageConsumption |
|---|
| Name | Usage Consumption API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514881/TMF677_Usage_Consumption_API_REST_Specification_17.5.0.pdf?api=v2 |
|---|
| Name | Usage Consumption API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514881/TMF677B_Usage_Consumption_API_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Usage Consumption API |
|---|
| |
|
...
...