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

Please be aware these are archived versions for historic access, please use the latest table unless you specifically need to access the previous version

  

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

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

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


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

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

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

_____________________________________

Document Number

Swagger

API Specification

Conformance Profile

CTK

Sample Implementation Code

Postman CollectionReleaseLifecycle 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




Not available

 

 

Not availableNot available17.0.1

Archived

N-2

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


Not availableNot available




15.5.1

Archived

N-2

Address API

The Address API is one of the Pre-Ordering Management APIs. The Address API provides a standardized client interface to an Address management system .It allows to look for worldwide addresses. It can also be used to validate address data, to be sure that it corresponds to a real address.

(Superseded by TMF673 Geographic Address Management API)

TMF647



Not availableNot available


16.0.1 Archived

N-2

Agreement Management API

  The Agreement API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.

TMF651



Not availableNot available


16.0.1  Archived

N-2

Appointment API

The Appointment API is one of the Pre-Ordering Management APIs. The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. First, the API consists in searching free slots based on parameters, as for example a party. Then, the appointment is created. The appointment has characteristics such as nature of appointment, place of appointment.

TMF646


Not availableNot available



16.0.1 Archived

N-2

Communication API

Provides a capability to create and send communications, notifications, and instructions to Parties, Individuals, Organizations or Users.

TMF681

Not availableNot availableNot available17.5.1  Archived

N-2

Customer Management API

Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.

TMF629




Not availableNot availableNot available17.0.1  Archived

N-2

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, Developper). 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




Not availableNot availableNot available17.0.1  Archived

N-2

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




Not availableNot availableNot available17.0.1   Archived

N-2

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







14.5.1  Archived

N-2

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







16.5.1  Archived

N-2

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


Not available

Not available



16.5.1  Archived

N-2

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



Not available

Not available



16.0.1  Archived

N-2

Service Catalog API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

TMF633


Not available

 

Not availableNot availableNot available16.5.1  Archived

N-2

Service Inventory Management API

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

TMF638


Not availableNot availableNot available18.0.1  Archived

N-2

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


Not availableNot availableNot available18.0.1  Archived

N-2

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




Not available

Not available

Not available

 

18.0.1  Archived

N-2

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

Not availableNot availableNot available18.0.1

 Archived

N-2

Shopping Cart API

Standardized mechanism for the management of shopping carts. Including creation, update, retrieval, deletion and notification of event. Shopping Cart entity is used for the temporary selection and reservation of product offerings in e-commerce and retail purchase.

TMF663



Not availableNot availableNot available17.0.1  Archived

N-2

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







14.5.1  Archived

N-2

 

 

 

  • No labels