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 |
Swagger Version |
Publication Date |
ODA Domain |
Notes |
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 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.1.0
|
10-Jan-2022 |
Business Partner, Customer |
|
Change Management API
The Change Management API provides the standard integration capabilities between external applications and Change Management Application
|
TMF655 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
|
v4.0.0
|
10-Jan-2022 |
Common |
|
Customer360 API
An API to give a consolidated Customer overview. This is a view-only API, based on the various underlying involved TM Forum Open APIs. This API provides references where one can find detailed information for: Account, Agreement, Appointment, CustomerBill, InteractionItem, LoyaltyBalance, ProductOrder, ProductValue, Promotion, Quote, ServiceProblem, TroubleTicket, UsageSpecification
|
TMF717 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
05-Jan-2022 |
Customer |
|
Digital Identity Management API
Provides the ability to manage a digital identity. This digital identity allows identification of an individual, a resource, or a partyRole (a specific role - or set of roles - for a given individual). A digital identity is associated with credential / authentification method. These credential / authentification methods should be extensible to describe all types of authentification method such as login/password, biometric, token, etc.. A contact medium is also associated with digital identity (or directly at credential level) to manage credential recovery UCs.
|
TMF720 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Business Partner, Common |
|
Entity Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.
|
TMF703 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Common |
|
Event Management API
The Event Management API provides a standardized client interface to the enterprise event management system for creating, managing and receiving service related events to (indicatively) drive automation workflows, notify other service providers for service outages and SLA violations, trigger Trouble Ticket creation, and enable more complex orchestration scenarios between management systems. The Event Management API can also be used to convey business level Events in support of other processes.
|
TMF688 |
|
|
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Common |
|
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 |
|
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Common |
|
Geographic Location Management API
Provides the information of a geographic region of the entity (customer, equipment, address).
|
TMF675 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Common |
|
IoT Device Management API Component Suite
In addition to including established TM Forum Open APIs, such as alarm management, resource management and activation APIs, the IoT Device Management API Component Suite also includes an IoT Data Access Endpoint API. This API allows for IoT data access using different types of protocols (MQTT IoT, CoAP, etc.). It encapsulates the protocols and allows devices to be easily integrated into solutions that support a host of IoT initiatives, including smart cities, smart factories and other vertical markets.
|
TMF908 |
|
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Resource |
|
IoT Service Management API Component Suite
The IoT Service Management Component suite captures the minimal essential operational APIs required to manage IoT service end to end, and therefore accelerate IoT infrastructure as a service and help manage IoT at scale.
|
TMF914 |
|
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Product, Common, Resource, Service |
|
Metadata Catalog Management API
Metadata Catalog
|
TMF725 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
|
v4.0.0
|
10-Jan-2022 |
Common |
|
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
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Service, Common |
|
Process Flow Management API
The ProcessFlow API allows management of business process. It provides all required information to achieve business task requiring manual action:
|
TMF701 |
|
|
|
Not yet available
|
Not yet available
|
Not yet available
|
19.0.1
|
v4.1.0
|
22-Nov-2021 |
Common |
|
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 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Product |
|
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 |
|
|
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Customer |
|
Resource Activation and Configuration API
The Resource Activation and Configuration API can be used to query resource instances to acquire the resource activation states and attributes, and it can be used to create/update, configure and activate the resource instances.
|
TMF702 |
|
|
|
|
|
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Resource, Common |
|
Service Test Management API
Service Test Description
|
TMF653 |
|
|
|
|
|
|
21.5.0
|
v4.2.0
|
10-Dec-2021 |
Service |
|
Shipment Management API
Shipment Management
|
TMF711 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
|
v4.0.0
|
10-Jan-2022 |
Business Partner |
|
Shipping Order Management API
Provides the necessary functionality to create, update and query Shipping Orders. A Shipping Order is a document used by a business to specify what items are to be transferred from a storage location or warehouse to which person and to which new location. A ShippingOrder typically is sent along with a shipment of goods so that the person receiving them can verify that the document correctly reflects the items that they actually received.
|
TMF700 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Business Partner |
|
Usage Consumption Management API
This API provides the real-time value within buckets (SMS, Voice, Data, TV for example) that a customer consumes with each of their devices, related to subscribed communication products without having to wait for the bill cycle. A usage report retrieves the data related to these balances.
|
TMF677 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
21.5.0
|
v4.0.0
|
22-Nov-2021 |
Product |
|
Work Order Management API
The Work Order API performs the following operations on a workOrder resource:
|
TMF697 |
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
Not yet available
|
|
v4.0.0
|
22-Nov-2021 |
Business Partner |
|