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:
...
...
| id | login-required |
|---|
| title | Login Required |
|---|
...
| 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 |
|---|
|
|
...
| id | members-only |
|---|
| title | For TM Forum Members |
|---|
...
| 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 | 1583876889487_210067569 |
|---|
| 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
...
Account Management API
Provides standardized mechanism for the management of billing and settlement accounts, as well as for financial accounting (account receivable) either in B2B or B2B2C contexts
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF666_AccountManagement/ |
|---|
| Name | Account Management API |
|---|
|
|
| Show If |
|---|
|
 Image Removed
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570284/TMF666_Account_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Account Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570284/TMF666B_Account_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Account Management API |
|---|
|
|
...
...
Archived
N-1
...
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.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/serviceActivationAndConfiguration/v2/swagger2.json |
|---|
| Name | Activation and Configuration API |
|---|
|
|
| Show If |
|---|
|
 Image Removed
|
...
| 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 |
|---|
|
|
...
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSSERVICEACTIVATION |
|---|
| Name | Activation and Configuration API |
|---|
|
|
| Show If |
|---|
|
 Image Removed
|
...
| 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
|
...
N-1
...
Agreement Management API
The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF651_AgreementManagement |
|---|
| Name | Agreement API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570257/TMF651_Agreement_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Agreement API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570257/TMF651B_Agreement_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Agreement API |
|---|
|
|
...
...
...
...
N-1
...
Appointment API
The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. The API allows searching of free slots based on parameters, as for example a party, then creating the appointment. The appointment has characteristics such as nature of appointment, place of appointment.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF646_AppointmentManagement |
|---|
| Name | Appointment API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570252/TMF646_Appointment_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Appointment API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570252/TMF646B_Appointment_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Appointment API |
|---|
|
|
...
...
Archived
N-1
Change Management API
The Change Management API provides the standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with Change Request in a consistent manner. A Change Request is an IT service management discipline.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/changeManagement/v2/swagger2.json |
|---|
| Name | Change Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84580882/TMF655_Change_Management_API_REST_Specification_R16.5.1.pdf?api=v2 |
|---|
| Name | Change Management API |
|---|
|
|
...
...
...
Archived
N-1
...
Communication API
Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/communicationManagement/v3/swagger2.json |
|---|
| Name | Communication API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514901/TMF681_Communication_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Communication API |
|---|
|
|
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514901/TMF681B_Communication_API_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Communication API |
|---|
|
|
...
Archived
N-1
...
Customer Management API
Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF629_CustomerManagement |
|---|
| Name | Customer Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570225/TMF629_Customer_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Customer Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570225/TMF629B_Customer_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Customer Management API |
|---|
|
|
...
Archived
N-1
...
Partnership Type Management API
Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of a partnership between parties, including the list of role types that are permitted (i.e Buyer, Seller, Developer). Role types may refer to agreement specifications to be signed by parties playing the role.
The API allows the retrieval, creation, update, and deletion of partnership type and its owned sub-resources.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF668_PartnershipType |
|---|
| Name | Partnership Type Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570289/TMF668_Partnership_Type_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Partnership Type Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570289/TMF668B_Partnership_Type_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Partnership Type Management API |
|---|
|
|
...
Archived
N-1
...
Party Management API
Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events.
Party can be an individual or an organization that has any kind of relationship with the enterprise.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/partyManagement/v2/swagger2.json |
|---|
| Name | Party Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF632_Party_Management_API_REST_Specification_R14.5.1%202015.pdf |
|---|
| Name | Party Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSPARTYMANAGEMENT/tree/develop |
|---|
| Name | Party Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFPartyManagementAPI.json.postman_collection |
|---|
| Name | Party Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
Archived
N-1
...
Party Role Management API
A standardized mechanism for general party roles and includes operations such as creation, update, retrieval, deletion and notification of events. Notice that for the management of customers there is a specific Customer Management API.
Party Role management API manages the following data resources: PartyRole
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF669_PartyRole |
|---|
| Name | Party Role Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570294/TMF669_Party_Role_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Party Role Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570294/TMF669B_Party_Role_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Party Role Management API |
|---|
|
|
...
Archived
N-1
...
Payment Methods API
This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon, and money transfer.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/paymentMethod/v3/swagger2.json |
|---|
| Name | Payment Methods API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514830/TMF670_Payment_Methods_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Payment Methods API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF670B_Payment_Methods_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Payment Methods API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://github.com/tmforum/CTKFILES/tree/master/paymentMethods |
|---|
| Name | Payment Methods API |
|---|
|
|
| Show If |
|---|
|
 Image Removed
|
...
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/CTKFILES/blob/master/paymentMethods/TMForum%20-%20PaymentMethodsAPI%20CTK.postman_collection.json |
|---|
| Name | Payment Methods API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
N-1
...
Product Catalog Management API
Provides a standardized solution for rapidly adding partners’ products to an existing Catalog. It brings the capability for Service Providers to directly feed partners systems with the technical description of the products they propose to them.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF620_ProductCatalog |
|---|
| Name | Product Catalog Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514836/TMF620_Product_Catalog_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Product Catalog Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514836/TMF620B_Product_Catalog_Management_Conformance%20_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Product Catalog Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://github.com/tmforum/PRODUCTCATALOG-CTK/archive/master.zip |
|---|
| Name | Product Catalog Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSPRODUCTCATALOG2/tree/master','RI','Product Catalog Management API |
|---|
| Name | Product Catalog Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductCatalogAPI.json.postman_collection |
|---|
| Name | Product Catalog Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
Archived
N-1
...
Product Inventory Management API
Provides standardized mechanism for product inventory management such as creation, partial or full update and retrieval of the representation of a product in the inventory. It also allows the notification of events related to product lifecycle.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF637_ProductInventory |
|---|
| Name | Product Inventory Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570230/TMF637_Product_Inventory_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Product Inventory Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570230/TMF637B_Product_Inventory_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Product Inventory Management API |
|---|
|
|
...
...
...
...
Archived
N-1
Product Offering Qualification API
Product Offering Qualification API is one of Pre-Ordering Management API Family. Product Offering Qualification API goal is to provide Product Offering commercial eligibility.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF679_ProductOfferingQualification |
|---|
| Name | Product Offering Qualification API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514891/TMF679_Product_Offering_Qualification_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Product Offering Qualification API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514891/TMF679B_Product_Offering_Qualification_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Product Offering Qualification API |
|---|
|
|
...
N-1
...
Product Ordering API
Provides a standardized mechanism for placing a product order with all of the necessary order parameters. The API consists of a simple set of operations that interact with CRM/Order negotiation systems in a consistent manner. A product order is created based on a product offering that is defined in a catalog. The product offering identifies the product or set of products that are available to a customer and includes characteristics such as pricing, product options and market.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF622_ProductOrder |
|---|
| Name | Product Ordering Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514841/TMF622_Product_Ordering_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Product Ordering Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514841/TMF622B_Product_Ordering_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Product Ordering Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSPRODUCTORDERING/tree/develop |
|---|
| Name | Product Ordering Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductOrderingAPI.json.postman_collection |
|---|
| Name | Product Ordering Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
Archived
N-1
...
Promotion API
Used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/promotionManagement/v3/swagger2.json |
|---|
| Name | Promotion API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514832/TMF671_Promotion_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Promotion API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF671B_Promotion_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Promotion API |
|---|
|
|
...
Archived
N-1
...
Quote Management API
The Quote API is one of the Pre-Ordering Management APIs. The customer Quote API provides a standardized mechanism for placing a customer quote with all of the necessary quote parameters.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF648_QuoteManagement |
|---|
| Name | Quote Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514851/TMF648_Quote_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Quote Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514851/TMF648B_Quote_Management_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Quote Management API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSQUOTE |
|---|
| Name | Quote Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSQUOTE/blob/master/POST-full-quote.json |
|---|
| Name | Quote Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
Archived
N-1
...
Recommendation API
Recommendation API is used to recommend offering quickly based on the history and real-time context of a customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.
...
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514896/TMF680_Recommendation_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
...
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514896/TMF680B_Recommendation_API_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
...
Archived
N-1
...
Resource Function Activation and Configuration API
This API introduces Resource Function which is used to represent a Network Service as well as a Network Function. The Network Service and Network Function class definitions and associations in TR244 (which, in turn, builds on concepts from the SID addenda on Logical Resource and Service) are utilized to define the Resource Function
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/resourceFunctionActivationConfiguration/v2/swagger2.json |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514820/TMF664_Resource_Function_Activation_and_Configuration_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF664B_Resource_Function_Config_and_Activation_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
...
N-1
...
Service Catalog API
The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF633_ServiceCatalog |
|---|
| Name | Service Catalog Management API |
|---|
|
|
...
| 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 |
|---|
|
|
...
...
| 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 |
|---|
|
|
...
N-1
...
Service Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF638_ServiceInventory |
|---|
| Name | Service Inventory Management API |
|---|
|
|
...
| 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 |
|---|
|
|
...
...
| 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 |
|---|
|
|
...
N-1
...
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.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF641_ServiceOrder |
|---|
| Name | Service Ordering Management API |
|---|
|
|
...
| 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 |
|---|
|
|
...
...
| 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 |
|---|
|
|
...
N-1
...
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.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF645_ServiceQualification |
|---|
| Name | Service Qualification API |
|---|
|
|
...
| 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 |
|---|
|
|
...
| 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 |
|---|
|
|
...
...
...
...
N-1
...
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.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/serviceQualityManagement/v2/swagger2.json |
|---|
| Name | Service Quality Management API |
|---|
|
|
| Show If |
|---|
|
Image Removed |
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84580781/TMF657_Service_Quality_Management_API_REST_Specification_R16.5.1.pdf?api=v2 |
|---|
| Name | Service Quality Management API |
|---|
|
|
...
...
Archived
N-1
...
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.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF653_ServiceTestManagement |
|---|
| Name | Service Test Management API |
|---|
|
|
...
| 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 |
|---|
|
|
...
...
| 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 |
|---|
|
|
...
Archived
N-1
...
Shopping Cart API
A standardized mechanism for the management of shopping carts. Including creation, update, retrieval, deletion and notification of an event. Shopping Cart entity is used for the temporary selection and reservation of product offerings in e-commerce and retail purchase.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF663_ShoppingCart |
|---|
| Name | Shopping Cart API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570279/TMF663_Shopping_Cart_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Shopping Cart API |
|---|
|
|
...
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570279/TMF663B_Shopping_Cart_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Shopping Cart API |
|---|
|
|
...
Archived
N-1
...
Trouble Ticket API
Provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets among partners as a result of an issue or problem identified by a customer or another system. Examples of Trouble Ticket API clients include CRM applications, network management or fault management systems, or other trouble ticket management systems (e.g. B2B).
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF621_TroubleTicket |
|---|
| Name | Trouble Ticket API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570213/TMF621_Trouble_Ticket_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Trouble Ticket API |
|---|
|
|
...
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570213/TMF621B_Trouble_Ticket_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Trouble Ticket API |
|---|
|
|
...
Not available
...
...
Archived
N-1
...
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.
...
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF677_UsageConsumption |
|---|
| Name | Usage Consumption API |
|---|
|
|
...
| 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 |
|---|
|
|
...
| 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 |
|---|
|
|
...
N-1
...