TM Forum Open APIs _____________________________________ | Document Number | Swagger (Apache 2.0 or RAND) | API User Guide / Specification (RAND) | Conformance Profile (RAND) | CTK | Sample Implementation Code | Postman Collection | Release | Lifecycle Status |
|---|
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 | TMF666 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF666_AccountManagement/ |
|---|
| Name | Account Management API |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
| 
|
| | Not available
| Not available
| 18.0.1 | 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. | TMF640 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF640_ActivationConfiguration/releases/download/v3.0.0/TMF640-ServiceActivationConfiguration-3.0.0.swagger.json |
|---|
| Name | Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144720/TMF640_Service_Activation_and_Configuration_API_REST_Specification_R18.5.0.pdf?api=v2 |
|---|
| Name | Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144720/TMF640B_Service_Activation_And_Configuration_Conformance_Profile_R18.5.0.pdf?api=v2 |
|---|
| Name | Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/CTK-TMF640-ServiceActivation-R18-5/archive/master.zip |
|---|
| Name | Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/RI-TMF640-ServiceActivation-R18-5 |
|---|
| Name | Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF640-ServiceActivation.zip |
|---|
| Name | Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
| 
|
| 18.5.1 | Archived N-1 |
Agreement Management API The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners. | TMF651 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF651_AgreementManagement |
|---|
| Name | Agreement API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| | | | 18.0.1 | Archived N-1 |
Alarm Management API The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces. | TMF642 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/alarmManagement/v3/swagger2.json |
|---|
| Name | Alarm Management API |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514808/TMF642_Alarm_Management_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Alarm Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF642B_Alarm_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Alarm Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.0.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. | TMF646 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF646_AppointmentManagement |
|---|
| Name | Appointment API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| | Not available | Not available | 18.0.1 | Archived N-1 |
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. | TMF663 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF663_ShoppingCart |
|---|
| Name | Shopping Cart API |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | 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.
| TMF655 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/changeManagement/v2/swagger2.json |
|---|
| Name | Change Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| | | Not available | Not available | 16.5.1 | Archived N-1 |
Change Management API The Change Management API provides standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with a Change Request in a consistent manner. | TMF655 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF655_ChangeManagement |
|---|
| Name | Change Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570269/TMF655_Change_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Change Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570269/TMF655B_Change_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Change Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| | Not yet available | Not yet available | 18.0.1 |
|
Communication API Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users. | TMF681 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF681_Communication |
|---|
| Name | Communication API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570314/TMF681_Communication_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Communication API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570314/TMF681B_Communication_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Communication API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | Archived N-1 |
Customer Bill Management API This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill. | TMF678 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF678_CustomerBill |
|---|
| Name | Customer Bill Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514886/TMF678_Customer_Bill_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Customer Bill Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514886/TMF678B_Customer_Bill_Management_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Customer Bill Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available
| Not available
| Not available
| 17.5.1 | 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. | TMF629 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF629_CustomerManagement |
|---|
| Name | Customer Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | Archived N-1 |
Document Management API Provides the operations to synchronize documents and document versions across systems. It also provides operations for uploading documents by Users as well as for viewing of documents online | TMF667 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/documentManagement/v2/swagger2.json |
|---|
| Name | Document Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514824/TMF667_Document_Management_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Document Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF667B_Document_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Document Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://github.com/tmforum/CTKFILES/tree/master/documentManagement |
|---|
| Name | Document Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | 17.0.1 |
|
Entity Catalog Management API The entity catalog is intended to provide any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. The API provides management of the entity specifications and their associations thru CRUD operations. | TMF662 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/entityCatalogManagement/v3/swagger2.json |
|---|
| Name | Entity Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514816/TMF662_Entity_Catalog_Management_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Entity Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF662B_Entity_Catalog_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Entity Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.0.1 |
|
Federated Identity API The management of principals of any kind (persons, objects, …) and their access to resources in an open environment which can span across different enterprise boundaries. It relies on authentication, authorization and consent mechanisms to protect privacy with a simple and easy user experience. Different parties can provide identity services (operators, social networks, GSMA, …). | TMF691 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF691_FederatedIdentity |
|---|
| Name | Federated Identity API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570334/TMF691_Federated_ID_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Federated Identity API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570334/TMF691B_Federated_ID_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Federated Identity API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 18.0.1 |
|
Geographic Address Management API Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street. | TMF673 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF673_GeographicAddress |
|---|
| Name | Geographic Address Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514866/TMF673_Geographic_Address_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Geographic Address Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514866/TMF673B_Geographic_Address_Management_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Geographic Address Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.5.1 |
|
Geographic Location Management API Provides the information of a geographic region of the entity (customer, equipment, address). | TMF675 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF675_GeographicLocation |
|---|
| Name | Geographic Location Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514876/TMF675_GeographicLocationManagement_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Geographic Location Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514876/TMF675B_Geographic_Location_Management_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Geographic Location Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.5.1 |
|
Geographic Site Management API Covers the operations to manage (create, read, delete) sites that can be associated with a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows easy reference to places important to other entities, where a geographic place is an entity that can answer the question “where?” | TMF674 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF674_GeographicSite |
|---|
| Name | Geographic Site Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514871/TMF674_Geographic_Site_Management_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514871/TMF674B_Geographic_Site_Management_API_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Geographic Site Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available
| Not available
| Not available
| 17.5.1 | Archived N-1 |
Loyalty Management API Supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances | TMF658 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF658_LoyaltyManagement |
|---|
| Name | Loyalty Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514814/TMF658_Loyalty_Management_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Loyalty Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF658B_Loyalty_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Loyalty Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/LoyaltyManagementAPI.postman_collection.json?api=v2 |
|---|
| Name | Loyalty Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 17.0.1 |
|
Network as a Service (NaaS) API Component Suite The API Component Suite supports of a set of Operational Domains exposing and managing “Network” Services. These services are referred to as Network as a Service (NaaS) and include all services offered from a service provider including connectivity, end points, media services, etc. | TMF909 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF909_NaaSComponentSuite |
|---|
| Name | Network as a Service API Suite |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/134777012/TMF909%20_API_Suite_Specification_for_NaaS_v3.pdf?api=v2 |
|---|
| Name | Network as a Service API Suite |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/146277001/TMF909-NetworkAsAService_RI-R18-5.zip?api=v2 |
|---|
| Name | Network as a Service API Suite |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143534323/TMF909_Network_as_a_Service_Postman.zip?api=v2 |
|---|
| Name | Network as a Service API Suite |
|---|
|
|
|
| Show If |
|---|
|
|
| 18.5.1 (v3.0.0) |
|
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. | TMF668 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF668_PartnershipType |
|---|
| Name | Partnership Type Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | Archived N-1 |
Party Interaction Management API A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us. | TMF683 |
| Show If |
|---|
| special | @authenticated |
|---|
| match | all |
|---|
| group | tmforum-members |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF683_PartyInteraction |
|---|
| Name | Party Interaction Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570319/TMF683_Party_Interactions_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Party Interaction Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570319/TMF683B_Party_Interactions_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Party Interaction Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | 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. | TMF632 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/partyManagement/v2/swagger2.json |
|---|
| Name | Party Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSPARTYMANAGEMENT/tree/develop |
|---|
| Name | Party Management API |
|---|
|
|
|
| Show If |
|---|
| 
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFPartyManagementAPI.json.postman_collection |
|---|
| Name | Party Management API |
|---|
|
|
|
| Show If |
|---|
| 
|
| 14.5.1 | 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 | TMF669 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF669_PartyRole |
|---|
| Name | Party Role Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | Archived N-1 |
Payment Management API The Payments API provides the standardized client interface to Payment Systems for notifying about performed payments or refunds. Examples of Payment API originators (clients) include Web servers, mobile app servers, Contact center dashboards or retail store systems. | TMF676 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF676_PaymentManagement |
|---|
| Name | Payment Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570304/TMF676_Payment_Management_API_REST_Specification_Proposal_R18.0.1.pdf?api=v2 |
|---|
| Name | Payment Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570304/TMF676B_Payment_Management_Conformance_Profile_R18.0.1.pdf?api=v2 |
|---|
| Name | Payment Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 18.0.1 | 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. | TMF670 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/paymentMethod/v3/swagger2.json |
|---|
| Name | Payment Methods API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://github.com/tmforum/CTKFILES/tree/master/paymentMethods |
|---|
| Name | Payment Methods API |
|---|
|
|
|
| Show If |
|---|
| 
|
| Not available |
| Show If |
|---|
|
| 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 |
|---|
|
|
| 17.0.1 | 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. | TMF670 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF670_PaymentMethods |
|---|
| Name | Payment Methods API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514861/TMF670_Payment_Methods_API_REST_Specification_R17.5.0.pdf?api=v2 |
|---|
| Name | Payment Methods API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514861/TMF670B_Payment_Methods_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Payment Methods API |
|---|
|
|
|
| Show If |
|---|
|
|
| | Not yet available |
| Show If |
|---|
|
| 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 |
|---|
|
|
| 17.5.1 |
|
Performance Management API Provides a standardized mechanism for performance management such as the creation, partial or full update and retrieval of resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It also allows notification of events related to performance. | TMF628 | Not yet available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF628_Performance_Management_API_REST_Specification_R14.5.1%202015.pdf |
|---|
| Name | Performance Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSMPMAPI/tree/dmapmapiv1.0/DSMPMAPIWP |
|---|
| Name | Performance Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | 14.5.1 |
|
Performance Management Threshold API Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance | TMF649 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/performanceManagementThreshold/v3/swagger2.json |
|---|
| Name | Performance Management Thresholding API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514810/TMF649_Performance_Threshold_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Performance Management Thresholding API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | Not yet available | 17.0.1 |
|
Prepay Balance Management API REST API for Balance Management. It includes the model definition as well as all available operations for prepay balance management. Prepaid subscribers pay fees before using services. Therefore, the subscribers must have sufficient balances. Operators can provide multiple recharge channels for subscribers. Subscribers can pass credit between different subscriptions, therefore transferring the balance from one account to another. | TMF654 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF654_PrepayBalanceManagement |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514812/TMF654_Prepay_Balance_Management_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF654B_Prepay_Balance_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/CTKFILES/blob/master/prepayBalanceManagement/TMForum%20-%20PrepayBalanceManagementAPI%20CTK.postman_collection.json |
|---|
| Name | Prepay Balance Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 17.0.1 | Archived N-1 |
Process Flow Management API The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action: - A ProcessFlow will describe an orchestration of TaskFlow
- In event-based architecture the processFlow are triggered as consequence of event
- TaskFlow could be completed automatically (rules, event triggered, process delegation) or requiring manual action
- Operations on taskFlow allow to update taskFlow
| TMF701 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF701_ProcessFlow |
|---|
| Name | Process Flow Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/128869433/TMF701_Process_Flow_Management_API_REST_Specification_R19.0.1.pdf?version=1&modificationDate=1585949431000&api=v2 |
|---|
| Name | Process Flow Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/128869433/TMF701B_Process_Flow_Management_Conformance_Profile_R19.0.1.pdf?version=1&modificationDate=1585949500000&api=v2 |
|---|
| Name | Process Flow Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available
| Not yet available
| Not yet available
| 19.0.1 (v4.0.0) |
|
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. | TMF620 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF620_ProductCatalog |
|---|
| Name | Product Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://github.com/tmforum/PRODUCTCATALOG-CTK/archive/master.zip |
|---|
| Name | Product Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSPRODUCTCATALOG2/tree/master','RI','Product Catalog Management API |
|---|
| Name | Product Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductCatalogAPI.json.postman_collection |
|---|
| Name | Product Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 17.5.1 | 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. | TMF637 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF637_ProductInventory |
|---|
| Name | Product Inventory Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| | | | 18.0.1 | 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.
| TMF679 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF679_ProductOfferingQualification |
|---|
| Name | Product Offering Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 17.5.1 | Archived 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. | TMF622 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF622_ProductOrder |
|---|
| Name | Product Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSPRODUCTORDERING/tree/develop |
|---|
| Name | Product Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductOrderingAPI.json.postman_collection |
|---|
| Name | Product Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 17.5.1 | 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 | TMF671 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/promotionManagement/v3/swagger2.json |
|---|
| Name | Promotion API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 17.0.1 | 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 | TMF671 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF671_Promotion |
|---|
| Name | Promotion API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570299/TMF671_Promotion_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Promotion API |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570299/TMF671B_Promotion_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Promotion API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 18.0.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. | TMF648 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF648_QuoteManagement |
|---|
| Name | Quote Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSQUOTE |
|---|
| Name | Quote Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSQUOTE/blob/master/POST-full-quote.json |
|---|
| Name | Quote Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 17.5.1 | 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. | TMF680 | |
| Show If |
|---|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 17.5.1 | 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. | TMF680 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF680_Recommendation |
|---|
| Name | Recommendation API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570309/TMF680_Recommendation_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570309/TMF680B_Recommendation_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Recommendation API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 18.0.1 |
|
Resource Catalog Management API The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process. | TMF634 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF634_ResourceCatalog |
|---|
| Name | Resource Catalog API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514804/TMF634_Resource_Catalog_Management_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Resource Catalog API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF634B_Resource_Catalog_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Resource Catalog API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.0.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 | TMF664 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/resourceFunctionActivationConfiguration/v2/swagger2.json |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 17.0.1 | 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 | TMF664 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/resourceFunctionActivationConfiguration/v2/swagger2.json |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514856/TMF664_Resource_Function_Activation_Configuration_API_R17.5.0.pdf?api=v2 |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514856/TMF664B_Resource_Function_Activation_Configuration_Conformance_Profile_R17.5.0.pdf?api=v2 |
|---|
| Name | Resource Function Activation and Configuration API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.5.1 |
|
Resource Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | TMF639 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF639_ResourceInventory |
|---|
| Name | Resource Inventory API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514806/TMF639_Resource_Inventory_Management_REST_API_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF639B_Resource_Inventory_Management_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | Resource Inventory API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | https://github.com/tmforum/CTKFILES/tree/master/resourceInventory |
|---|
| Name | Resource Inventory API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | 17.0.1 | Archived N-1 |
Resource Ordering Management API The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters. | TMF652 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF652_ResourceOrderManagement |
|---|
| Name | Resource Order Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84580751/TMF652_Resource_Ordering_Management_API_REST_Specification_R16.5.1.pdf?api=v2 |
|---|
| Name | Resource Order Management API |
|---|
|
|
|
| Show If |
|---|
| |
| Not yet available | Not yet available | Not yet available | Not yet available | 16.5.1 |
|
Resource Pool Management API Resource Pool management API provides a feature of resource reservation at pre-order phase. In order to reserve a physical product, logical product, and virtual product, the API uses the idea of a resource pool. | TMF685 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF685_ResourcePool |
|---|
| Name | Resource Pool Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570329/TMF685_Resource_Pool_Management_API_REST_Specification_R18.0.0.pdf?api=v2 |
|---|
| Name | Resource Pool Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570329/TMF685B_Resource_Pool_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2 |
|---|
| Name | Resource Pool Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 18.0.1 |
|
Self Care API Component Suite The Self Care API component suite covers the operations required to be exposed in order to provide the functionality required by a SelfCare application used by a Service Provider to allow its customers to manage the services it has subscribed to. | TMF910 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF910_SelfCareComponentSuite |
|---|
| Name | Self-Care API Component Suite |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/143528857/TMF910_Self_Care_API_Component_Suite_R18.0.1.pdf?api=v2 |
|---|
| Name | Self-Care API Component Suite |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | Not yet available | 18.0.1 |
|
Service Catalog API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | TMF633 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF633_ServiceCatalog |
|---|
| Name | Service Catalog Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| 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 |
|---|
| |
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 17.5.1 | Archived 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. | TMF638 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF638_ServiceInventory/releases/download/v3.0.0/TMF638-ServiceInventory-3.0.0.swagger.json |
|---|
| Name | Service Inventory Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144715/TMF638_Service_Inventory_API_REST_Specification_R18.5.0.pdf?api=v2 |
|---|
| Name | Service Inventory Management API |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144715/TMF638B_Service_Inventory_Conformance_Profile_R18.5.0.pdf?api=v2 |
|---|
| Name | Service Inventory Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/CTK-TMF638-ServiceInventory/releases/download/18.5.0/CTK-TMF638-ServiceInventory-R18-5.zip |
|---|
| Name | Service Inventory Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/RI-TMF638-ServiceInventoryManagement-R18-5 |
|---|
| Name | Service Inventory Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF638-ServiceInventory.zip |
|---|
| Name | Service Inventory Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 18.5.1 | Archived 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. | TMF641 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF641_ServiceOrder/releases/download/v3.0.0/TMF641-ServiceOrdering-3.0.0.swagger.json |
|---|
| Name | Service Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144723/TMF641_Service_Ordering_API_REST_Specification_R18.5.0.pdf?api=v2 |
|---|
| Name | Service Ordering Management API |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144723/TMF641B_Service_Ordering_Conformance_Profile_R18.5.0.docx?api=v2 |
|---|
| Name | Service Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/CTK-TMF641-ServiceOrdering/releases/download/18.5.0/CTK-TMF641-ServiceOrdering-R18-5.zip |
|---|
| Name | Service Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/RI-TMF641-ServiceOrderingManagement-R18-5 |
|---|
| Name | Service Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF641-ServiceOrdering.zip |
|---|
| Name | Service Ordering Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 18.5.1 | Archived 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. | TMF645 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF645_ServiceQualification/releases/download/v3.0.0/TMF645-ServiceQualification-3.0.0.swagger.json |
|---|
| Name | Service Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144727/TMF645_Service_Qualification_Management_API_REST_Specification_R18.5.0.pdf?api=v2 |
|---|
| Name | Service Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110144727/TMF645B_Service_Qualification_Conformance_Profile_R18.5.0.pdf?api=v2 |
|---|
| Name | Service Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/CTK-TMF645-ServiceQualification/releases/download/18.5.0/CTK-TMF645-ServiceQualification-R18-5.zip |
|---|
| Name | Service Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/RI-TMF645-ServiceQualification-R18-5 |
|---|
| Name | Service Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF645-ServiceQualification.zip |
|---|
| Name | Service Qualification API |
|---|
|
|
|
| Show If |
|---|
|
|
| 18.5.1 | Archived 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. | TMF657 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/serviceQualityManagement/v2/swagger2.json |
|---|
| Name | Service Quality Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| | Not available | Not available | Not available | 16.5.1 | Archived 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. | TMF657 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF657_ServiceQualityManagement |
|---|
| Name | Service Quality Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| 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 |
|---|
| |
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 18.0.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.
| TMF653 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF653_ServiceTestManagement/releases/download/v3.0.0/TMF653-ServiceTest-3.0.0.swagger.json |
|---|
| Name | Service Test Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110150718/TMF653_Service_Test_Management_API_REST_Specification_R18.5.1.pdf?api=v2 |
|---|
| Name | Service Test Management API |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/110150718/TMF653B_Service_Test_Management_API_Conformance_Profile_R18.5.1.pdf?api=v2 |
|---|
| Name | Service Test Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/CTK-TMF653-ServiceTest/releases/download/18.5.0/CTK-TMF653-ServiceTest-R18-5.zip |
|---|
| Name | Service Test Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/RI-TMF653-ServiceTestManagement-R18-5 |
|---|
| Name | Service Test Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Licence | RAND |
|---|
| Link | https://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF653-ServiceTest.zip |
|---|
| Name | Service Test Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 18.5.1 | Archived N-1 |
Shipment Tracking API Shipment Tracking captures information about the current status of the shipment, the past checkpoints and the estimated arrival date. Via this API, tracking information can be retrieved by providing an order Id or the shipping company’s tracking id. | TMF684 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF684_ShipmentTracking |
|---|
| Name | Shipment Tracking API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570324/TMF684_Shipment_Tracking_API_REST_Specification_R18.0.1.pdf?api=v2 |
|---|
| Name | Shipment Tracking API |
|---|
|
|
|
| Show If |
|---|
| |
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Licence | RAND |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/96570324/TMF684B_Shipment_Tracking_Conformance_Profile_R18.0.1.pdf?api=v2 |
|---|
| Name | Shipment Tracking API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 18.0.1 |
|
SLA Management API Provides a standardized interface for Service Level Agreement (SLA) life-cycle Management (SLA Negotiation, SLA configuration SLA Activation/enforcement, SLA Operations, SLA violation / consequence handling, SLA reporting) between a Customer and a Service Provider which provides offers (product with attached SLA in its catalogue) the customer can discover, browse, trigger and order. | TMF623 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/slaManagement/v2/swagger2.json |
|---|
| Name | SLA Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF623_SLA_Management_API_REST_Specification_R14.5.1%202015.pdf |
|---|
| Name | SLA Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSMSLAAPI/tree/develop |
|---|
| Name | SLA Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFSLAManagementAPI.json.postman_collection |
|---|
| Name | SLA Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 14.5.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). | TMF621 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF621_TroubleTicket |
|---|
| Name | Trouble Ticket API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| | | | 18.0.1 | 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. | TMF677 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF677_UsageConsumption |
|---|
| Name | Usage Consumption API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| 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 |
|---|
|
|
|
| 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 |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available | Not available | 17.5.1 | Archived N-1 |
Usage Management API Provides standardized mechanism for usage management such as creation, update, retrieval, import and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to 1) retrieve usage generated by a partner service platform in order to rate it and 2) to provide rated usage to a partner for consumption follow up purposes. | TMF635 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF635_UsageManagement |
|---|
| Name | Usage Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF635_Usage_Management_API_REST_Specification_R14.5.1%202015.pdf |
|---|
| Name | Usage Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not available | Not available |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | https://github.com/tmforum/DSUSAGEMANAGEMENT |
|---|
| Name | Usage Management API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFUsageManagementAPI.json.postman_collection |
|---|
| Name | Usage Management API |
|---|
|
|
|
| Show If |
|---|
|
|
| 14.5.1 | Archived N-1 |
User Roles & Permissions API A user role is defined as the entity that defines a set of privileges covering various functions and/or manageable assets. When a user is assigned a given role then it is actually allocated all the privileges defined for that role type and the corresponding permissions are created for that user. | TMF672 |
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Licence | Apache 2.0 |
|---|
| Link | https://github.com/tmforum-apis/TMF672_UserRolesPermissions |
|---|
| Name | User Roles & Permissions API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/90514834/TMF672_User_Roles_and_Permissions_API_REST_Specification_R17.0.1.pdf?api=v2 |
|---|
| Name | User Roles & Permissions API |
|---|
|
|
|
| Show If |
|---|
|
|
|
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/84575796/TMF672B_User_Roles_Permissions_API_Conformance_Profile_R17.0.docx?api=v2 |
|---|
| Name | User Roles & Permissions API |
|---|
|
|
|
| Show If |
|---|
|
|
| Not yet available | Not yet available | Not yet available | 17.0.1 |
|
