Page tree
Skip to end of metadata
Go to start of metadata

The increasingly complex multi-partner digital services value chain raises new challenges in terms of ensuring time-to-market, seamless management, cost-effectiveness and revenue sharing.

In order to meet these challenges, TM Forum members including the world’s largest service providers and suppliers, have been working to develop APIs that enable the open digital ecosystem and provide critical management functionality to digital services.

This table contains links to Beta versions of the Open APIs which are available to TM Forum members oAPI Project Members only.

By default, the information in the table is sorted by API title, but can be re-sorted (for example, by Document Number or Release Version) by clicking on the relevant column headings.

Please note that Comments are no longer permitted on this page. If you have any questions regarding the content of the Open API Table please post them as discussion topics on the   Open API Community Forum .




To access the API table links below you will need to be logged in

To login with your TM Forum account please click on the Login button below

Login

Don't have an account? You can register by clicking here:

Register


TM Forum Open APIs

Early Adoption (Beta) Versions


Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


TM Forum Open APIs

Pre-Production

_____________________________________

Document Number

Swagger

(Apache 2.0)

API User Guide

(RAND)

Conformance Profile

(RAND)

CTK

Sample Implementation Code

Postman CollectionReleaseVersionLifecycle Status

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

4.0.0Pre-production

Entity Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Entity inventory.

The Entity Inventory API can be used to query the Entity and Association instances.

The Entity Inventory API can be called by an order management system to create new Entity/Association instances or update existing Entity/Association instances in the Entity Inventory.

TMF703

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

Geographic Location Management API

Provides the information of a geographic region of the entity (customer, equipment, address).

TMF675

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

Payment Method 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

Not Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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

Not availableNot availableNot available

19.0.1

(v4.0.0)Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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

Not Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

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 AvailableNot Yet AvailableNot Yet AvailableNot Yet AvailableNot Yet Available

21.5.0

4.0.0Pre-production

Work Order Management API

The Work Order API performs the following operations on a workOrder resource:

  • Retrieval of a workOrder or a collection of workOrder depending on filter criteria
  • Partial update of a workOrder (including updating rules)
  • Creation of a workOrder (including default values and creation rules)
  • Deletion of a workOrder (for administration purposes)
  • Notification of events on a workOrder.


TMF697









 Note: Reference/Sample implementation is not an architecture direction but a sample in a sandbox

 

 

 







  • No labels