Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 the latest Production versions. For early adoption versions see Open API Table - Early Adoption (Beta)

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 .


We are now collecting input for the latest update to our Open API Adoption Assessment Report.

Please click here for further information | click here for the vendor survey | click here for the CSP survey




Hide If
special@authenticated


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

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

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

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

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue




Dialog
idlogin-required
titleLogin Required


Section


Panel
borderStylenone

To access the API documentation you need to be logged in to your TM Forum account

Button Hyperlink
titleLogin
typeprimary
urlhttps://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable

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

Button Hyperlink
titleRegister
typeprimary
urlhttps://www.tmforum.org/user-registration/
targettrue




Dialog
idmembers-only
titleFor TM Forum Members


Section


Panel
borderStylenone

Thank you for your interest in this Early Adopter API. 
We're sorry but the documentation is available to members only.
As a non-member, you are welcome to browse our Released TM Forum Open API documentation

Button Hyperlink
titleBrowse Released APIs
typeprimary
urlhttps://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs
Button Hyperlink
titleFind out more about Membership
typestandard
urlhttps://www.tmforum.org/membership/benefits/
targettrue



TM Forum Open APIs

Production Versions

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

Table Filter
sparkNameSparkline
datepatternyy-mm-dd
id1581923749894_1192378210
sortReleased TM Forum Open APIs (‍Asc)
isORAND
separatorPoint (.)


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 CollectionReleaseVersionLifecycle 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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF666_AccountManagement
NameAccount Management API

 



Show If
special@anonymous



Show If
special@authenticated
grouptmforum-members


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080614/TMF666_Account_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569391040485&api=v2
NameAccount Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080614/TMF666B_Account_Management_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569391041327&api=v2
NameAccount Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF666-Account-v4.0.0.zip?api=v2
NameAccount Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080614/implementation.zip?version=1&modificationDate=1569391040209&api=v2
NameAccount Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080614/postman.zip?version=1&modificationDate=1569391040351&api=v2
NameAccount Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 

CTK updated


Production

Agreement Management API

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

TMF651


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF651_AgreementManagement
NameAgreement API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080631/TMF651_Agreement_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569390373000&api=v2
NameAgreement API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080631/TMF651B_Agreement_Management_API_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569390374000&api=v2
NameAgreement API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080631/CTK-TMF651-Agreement-4.0.0.zip?version=1&modificationDate=1569390373000&api=v2
NameAgreement API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080631/implementation.zip?version=1&modificationDate=1569390373000&api=v2
NameAgreement API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080631/postman.zip?version=1&modificationDate=1569390373000&api=v2
NameAgreement API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


Production

AI Management API Component Suite

The API Component Suite for AI Management defines the set of operations that should be offered in order that a Service Provider can govern Artificial Intelligence systems deployed at scale. Effective governance and management of AI must span the lifecycle from design through deployment and eventual withdrawal from service. However, the initial focus of the AI Management API is restricted to the in-life aspects of AI and in particular on the management of ‘model contracts’.

TMF915


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF915_AIManagementSuite
NameAI Management API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532119/TMF915_AI_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameAI Management API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532098/TMF915_AI_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameAI Management API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF915_AI_V4-0-0.zip?api=v2
NameAI Management API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF915-AIManagement-v4.zip?api=v2
NameAI Management API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF915-AIManagement-v4-Postman.zip?api=v2
NameAI Management API Component Suite

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceRAND
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/alarmManagement/v3/swagger2.json
NameAlarm Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514808/TMF642_Alarm_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameAlarm Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF642B_Alarm_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameAlarm Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.0.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF646_AppointmentManagement
NameAppointment API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080629/TMF646_Appointment_API_Specification_R19.0.0_fixed.pdf?version=1&modificationDate=1569389917845&api=v2
NameAppointment API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080629/TMF646B_Appointment_API_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569389918342&api=v2
NameAppointment API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080629/CTK-TMF646-Appointment-4.0.0.zip?version=1&modificationDate=1569389917132&api=v2
NameAppointment API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080629/implementation.zip?version=1&modificationDate=1569389917338&api=v2
NameAppointment API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080629/postman.zip?version=1&modificationDate=1569389917483&api=v2
NameAppointment API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF655_ChangeManagement
NameChange Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570269/TMF655_Change_Management_API_REST_Specification_R18.0.0.pdf?api=v2
NameChange Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570269/TMF655B_Change_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2
NameChange Management API

 



Show If
special@anonymous


Not yet available

Not yet availableNot yet available18.0.1
Production

Communication API

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

TMF681


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF681_Communication
NameCommunication API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792901/TMF681_Communication_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameCommunication API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/154179123/TMF681B_Communication_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameCommunication API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF681-Communication_v4.0.0.zip?api=v2
NameCommunication API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF681-Communication-v4.zip?api=v2
NameCommunication API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF681-Communication-v4.0.0.postman_collection.json.zip?api=v2
NameCommunication API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF678_CustomerBill
NameCustomer Bill Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792897/TMF678_Customer_Bill_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameCustomer Bill Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146299991/TMF678B_Customer_Bill_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameCustomer Bill Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF678_Customer_Bill_V4-0-0.zip?api=v2
NameCustomer Bill Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF678-Customer_Bill-v4.zip?api=v2
NameCustomer Bill Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF678-Customer_Bill-v4.0.0.postman_collection.json.zip?api=v2
NameCustomer Bill Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF629_CustomerManagement
NameCustomer Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080639/TMF629_Customer_Management_Specification_API_REST_R19.0.0.pdf?version=1&modificationDate=1569388615436&api=v2
NameCustomer Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080639/TMF629B_Customer_Management_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569388616000&api=v2
NameCustomer Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF629-Customer-v4.0.0.zip?api=v2
NameCustomer Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080639/implementation.zip?version=1&modificationDate=1569388615151&api=v2
NameCustomer Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080639/postman.zip?version=1&modificationDate=1569388615276&api=v2
NameCustomer Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 

CTK updated


Production

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
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/documentManagement/v2/swagger2.json
NameDocument Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514824/TMF667_Document_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameDocument Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF667B_Document_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameDocument Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://github.com/tmforum/CTKFILES/tree/master/documentManagement
NameDocument Management API

 



Show If
special@anonymous


Not yet availableNot yet available17.0.1
Production 

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
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/entityCatalogManagement/v3/swagger2.json
NameEntity Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514816/TMF662_Entity_Catalog_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameEntity Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF662B_Entity_Catalog_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameEntity Catalog Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.0.1
 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


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF691_FederatedIdentity
NameFederated Identity API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570334/TMF691_Federated_ID_API_REST_Specification_R18.0.0.pdf?api=v2
NameFederated Identity API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570334/TMF691B_Federated_ID_API_Conformance_Profile_R18.0.0.pdf?api=v2
NameFederated Identity API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available18.0.1
Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF673_GeographicAddress
NameGeographic Address Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514866/TMF673_Geographic_Address_Management_API_REST_Specification_R17.5.0.pdf?api=v2
NameGeographic Address Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514866/TMF673B_Geographic_Address_Management_Conformance_Profile_R17.5.0.pdf?api=v2
NameGeographic Address Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.5.1
 Production

Geographic Location Management API

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

TMF675


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF675_GeographicLocation
NameGeographic Location Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514876/TMF675_GeographicLocationManagement_API_REST_Specification_R17.5.0.pdf?api=v2
NameGeographic Location Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514876/TMF675B_Geographic_Location_Management_Conformance_Profile_R17.5.0.pdf?api=v2
NameGeographic Location Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.5.1
Production 

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF674_GeographicSite
NameGeographic Site Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/134776996/TMF674_Geographic_Site_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameGeographic Site Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532476/TMF674B_Geographic_Site_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameGeographic Site Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF674-GeographicSite_v4.0.0.zip?api=v2
NameGeographic Site Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF674-GeographicSite-v4.zip?api=v2
NameGeographic Site Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF674-GeographicSite-v4-Postman.zip?api=v2
NameGeographic Site Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production 

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF658_LoyaltyManagement
NameLoyalty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514814/TMF658_Loyalty_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameLoyalty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF658B_Loyalty_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameLoyalty Management API

 



Show If
special@anonymous


Not yet availableNot yet available


Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/LoyaltyManagementAPI.postman_collection.json?api=v2
NameLoyalty Management API

 



Show If
special@anonymous


17.0.1
Production 

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF909_NaaSComponentSuite
NameNetwork as a Service API Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134777012/TMF909%20_API_Suite_Specification_for_NaaS_v3.pdf?api=v2
NameNetwork as a Service API Suite

 



Show If
special@anonymous


Not yet available
Not yet available


Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF909-NetworkAsAService_RI-R18-5.zip?api=v2
NameNetwork as a Service API Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF909_Network_as_a_Service_Postman.zip?api=v2
NameNetwork as a Service API Suite

 



Show If
special@anonymous


18.5.1

(v3.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF668_PartnershipType
NamePartnership Type Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080625/TMF668_Partnership_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569391292641&api=v2
NamePartnership Type Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080625/TMF668B_Partnership_Management_API_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569391293056&api=v2
NamePartnership Type Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080625/CTK-TMF668-Partnership-4.0.0.zip?version=1&modificationDate=1569391292014&api=v2
NamePartnership Type Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080625/implementation.zip?version=1&modificationDate=1569391292193&api=v2
NamePartnership Type Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080625/Partnership_Type.regular.swagger.json?version=1&modificationDate=1569391292404&api=v2
NamePartnership Type Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


Production

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
matchall
grouptmforum-members


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF683_PartyInteraction
NameParty Interaction Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792905/TMF683_Party_Interaction_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameParty Interaction Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/display/API/TMF683B+Party+Interaction+API+Conformance+Profile+v4.0.0
NameParty Interaction Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF683-PartyInteraction_v4.0.0.zip?api=v2
NameParty Interaction Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF683-PartyInteraction-v4.zip?api=v2
NameParty Interaction Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF683-PartyInteraction-v4.0.0.postman_collection.json.zip?api=v2
NameParty Interaction Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF632_PartyManagement
NameParty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080621/TMF632_Party_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569389311181&api=v2
NameParty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080621/TMF632B_Party_Management_API_REST_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569389312188&api=v2
NameParty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF632-Party_v4.0.0.zip?api=v2
NameParty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080621/implementation.zip?version=1&modificationDate=1569389310544&api=v2
NameParty Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080621/postman.zip?version=1&modificationDate=1569389311051&api=v2
NameParty Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 

CTK updated


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF669_PartyRole
NameParty Role Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080627/TMF669_Party_Role_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569391456579&api=v2
NameParty Role Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080627/TMF669B_Party_Role_Management_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569391456991&api=v2
NameParty Role Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF669-PartyRole.zip?api=v2
NameParty Role Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080627/implementation.zip?version=1&modificationDate=1569391456036&api=v2
NameParty Role Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080627/postman.zip?version=1&modificationDate=1569391456388&api=v2
NameParty Role Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 

CTK updated


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF676_PaymentManagement
NamePayment Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532510/TMF676_Payment_Management_API_User_Guide_v4.0.0.pdf?api=v2
NamePayment Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532517/TMF676B_Payment_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2
NamePayment Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF676_Payment_V4-0-0.zip?api=v2
NamePayment Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF676-Payment-v4.zip?api=v2
NamePayment Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF676-Payment-v4.0.0.postman_collection.json.zip?api=v2
NamePayment Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF670_PaymentMethods
NamePayment Methods API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514861/TMF670_Payment_Methods_API_REST_Specification_R17.5.0.pdf?api=v2
NamePayment Methods API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514861/TMF670B_Payment_Methods_Conformance_Profile_R17.5.0.pdf?api=v2
NamePayment Methods API

 



Show If
special@anonymous


Not yet available

Not yet available


Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum/CTKFILES/blob/master/paymentMethods/TMForum%20-%20PaymentMethodsAPI%20CTK.postman_collection.json
NamePayment Methods API

 



Show If
special@anonymous


17.5.1
 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. 

TMF628Not yet available


Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF628_Performance_Management_API_REST_Specification_R14.5.1%202015.pdf
NamePerformance Management API

 



Show If
special@anonymous


Not yet availableNot yet available


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSMPMAPI/tree/dmapmapiv1.0/DSMPMAPIWP
NamePerformance Management API

 



Show If
special@anonymous


Not yet available14.5.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/performanceManagementThreshold/v3/swagger2.json
NamePerformance Management Thresholding API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514810/TMF649_Performance_Threshold_API_REST_Specification_R17.0.1.pdf?api=v2
NamePerformance Management Thresholding API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet availableNot yet available17.0.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF654_PrepayBalanceManagement
NamePrepay Balance Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532459/TMF654_PrepayBalance_Management_API_User_Guide_v4.0.0.pdf?api=v2
NamePrepay Balance Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532463/TMF654B_Prepay_Balance_API_Conformance_Profile_v4.0.0.pdf?api=v2
NamePrepay Balance Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF654_Prepay_Balance_V4-0-0.zip?api=v2
NamePrepay Balance Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF654-PrepayBalance-v4.zip?api=v2
NamePrepay Balance Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF654-PrepayBalance-v4-Postman.zip?api=v2
NamePrepay Balance Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


 Production

Privacy Management API

The Privacy management API provides a standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events

TMF644


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://projects.tmforum.org/wiki/download/attachments/123090132/TMF644_Privacy-4.0.0.swagger.json?version=1&modificationDate=1573117743866&api=v2
NamePrivacy Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792881/TMF644_Privacy_Management_API_User_Guide_v4.0.0.pdf?api=v2
NamePrivacy Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532424/TMF644B_Privacy_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2
NamePrivacy Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF644_Privacy_v4.0.0.zip?api=v2
NamePrivacy Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF644-Privacy-v4.zip?api=v2
NamePrivacy Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF644-Privacy-v4-Postman.zip?api=v2
NamePrivacy Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


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


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF701_ProcessFlow
NameProcess Flow Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/128869433/TMF701_Process_Flow_Management_API_REST_Specification_R19.0.1.pdf?version=1&modificationDate=1585949431000&api=v2
NameProcess Flow Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/128869433/TMF701B_Process_Flow_Management_Conformance_Profile_R19.0.1.pdf?version=1&modificationDate=1585949500000&api=v2
NameProcess Flow Management API

 



Show If
special@anonymous


Not yet available

 

Not yet available

 

Not yet available

 

19.0.1

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF620_ProductCatalog
NameProduct Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/172109457/TMF620_Product_Catalog_Management_API_REST_Specification_v4-1-0.pdf?api=v2
NameProduct Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080285/TMF620B_Product_Catalog_Management_Conformance%20_Profile_R19.0.0.pdf?version=1&modificationDate=1569382595088&api=v2
NameProduct Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF620_Product_catalog_V4-0-0.zip?api=v2
NameProduct Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080285/implementation.zip?version=1&modificationDate=1569387607788&api=v2
NameProduct Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080285/postman.zip?version=1&modificationDate=1569387607960&api=v2
NameProduct Catalog Management API

 



Show If
special@anonymous


21.0.0

(v4.1.0)


 

CTK updated


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF637_ProductInventory
NameProduct Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080633/TMF637_Product_Inventory_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569389613732&api=v2
NameProduct Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080633/TMF637B_Product_Inventory_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569389614448&api=v2
NameProduct Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF637-ProductInventory.zip?api=v2
NameProduct Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF637-ProductInventory-v4.zip?api=v2
NameProduct Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080633/postman.zip?version=1&modificationDate=1569389613288&api=v2
NameProduct Inventory Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)

 

CTK updated


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF679_ProductOfferingQualification
NameProduct Offering Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080609/TMF679_Product_Offering_Qualification_Management_API_REST_Specification_....pdf?version=1&modificationDate=1569391787054&api=v2
NameProduct Offering Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080609/TMF679B_Product_Offering_Qualification_Management_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569391787699&api=v2
NameProduct Offering Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080609/CTK-TMF679-Product_Offering_Qualification-4.0.0.zip?version=1&modificationDate=1569391786240&api=v2
NameProduct Offering Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080609/implementation.zip?version=1&modificationDate=1569391786479&api=v2
NameProduct Offering Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080609/postman.zip?version=1&modificationDate=1569391786681&api=v2
NameProduct Offering Qualification API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF622_ProductOrder
NameProduct Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080637/TMF622_Product_Ordering_Management_API_REST_Specification_R19.0.pdf?version=1&modificationDate=1569388424646&api=v2
NameProduct Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080637/TMF622B_Product_Ordering_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569388425355&api=v2
NameProduct Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF622-ProductOrdering.zip?api=v2
NameProduct Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF622-ProductOrdering-v4.zip?api=v2
NameProduct Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080637/postman.zip?version=1&modificationDate=1569388424303&api=v2
NameProduct Ordering Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)

 

CTK updated


 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


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF671_Promotion
NamePromotion API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570299/TMF671_Promotion_API_REST_Specification_R18.0.0.pdf?api=v2
NamePromotion API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570299/TMF671B_Promotion_API_Conformance_Profile_R18.0.0.pdf?api=v2
NamePromotion API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available18.0.1
Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF648_QuoteManagement
NameQuote Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080616/TMF648_Quote_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569390180875&api=v2
NameQuote Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080616/TMF648B_Quote_Management_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569390181500&api=v2
NameQuote Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080616/CTK-TMF648-Quote-4.0.0.zip?version=1&modificationDate=1569390180252&api=v2
NameQuote Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080616/implementation.zip?version=1&modificationDate=1569390180441&api=v2
NameQuote Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080616/postman.zip?version=1&modificationDate=1569390180582&api=v2
NameQuote Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 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


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF680_Recommendation
NameRecommendation API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570309/TMF680_Recommendation_API_REST_Specification_R18.0.0.pdf?api=v2
NameRecommendation API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570309/TMF680B_Recommendation_API_Conformance_Profile_R18.0.0.pdf?api=v2
NameRecommendation API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available18.0.1
Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF634_ResourceCatalog
NameResource Catalog API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514804/TMF634_Resource_Catalog_Management_API_REST_Specification_R17.0.1.pdf?api=v2
NameResource Catalog API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF634B_Resource_Catalog_Management_API_Conformance_Profile_R17.0.docx?api=v2
NameResource Catalog API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.0.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/resourceFunctionActivationConfiguration/v2/swagger2.json
NameResource Function Activation and Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514856/TMF664_Resource_Function_Activation_Configuration_API_R17.5.0.pdf?api=v2
NameResource Function Activation and Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514856/TMF664B_Resource_Function_Activation_Configuration_Conformance_Profile_R17.5.0.pdf?api=v2
NameResource Function Activation and Configuration API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.5.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF639_ResourceInventory
NameResource Inventory API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792865/TMF639_Resource_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameResource Inventory API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532386/TMF639B_Resource_Inventory_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameResource Inventory API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF639_Resource_Inventory_V4-0-0.zip?api=v2
NameResource Inventory API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF639-ResourceInventory-v4.zip?api=v2
NameResource Inventory API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF639-ResourceInventory-v4-Postman.zip?api=v2
NameResource Inventory API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF652_ResourceOrderManagement
NameResource Order Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84580751/TMF652_Resource_Ordering_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NameResource Order Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet availableNot yet available16.5.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF685_ResourcePool
NameResource Pool Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570329/TMF685_Resource_Pool_Management_API_REST_Specification_R18.0.0.pdf?api=v2
NameResource Pool Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570329/TMF685B_Resource_Pool_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2
NameResource Pool Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available18.0.1
Production

Sales Management API

The Sales Management API provides interfaces for Sales Lead, Sales Opportunity, Sales Quote and the other management capabilities to support the sales activities to build relationship with the prospect customer who could be a person or organization that has an interest in the goods and/or services and possibly become the actual customers with one or more subscriptions.

TMF699


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF699_Sales
NameSales Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080618/TMF699_Sales_Management_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569391957000&api=v2
NameSales Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080618/TMF699B_Sales_Management_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569391958000&api=v2
NameSales Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceApache 2.0
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080618/CTK-TMF699-Sales-4.0.0.zip?version=1&modificationDate=1569391956000&api=v2
NameSales Management API

 



Show If
special@anonymous



Show If
special@authenticated
matchall


Trackinglink
TypeRI
LicenceApache 2.0
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080618/implementation.zip?version=1&modificationDate=1569391956000&api=v2
NameSales Management API

 



Show If
special@anonymous



Show If
special@authenticated
matchall


Trackinglink
TypePostman
LicenceApache 2.0
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080618/postman.zip?version=1&modificationDate=1569391957000&api=v2
NameSales Management API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF910_SelfCareComponentSuite
NameSelf-Care API Component Suite

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143528857/TMF910_Self_Care_API_Component_Suite_R18.0.1.pdf?api=v2
NameSelf-Care API Component Suite

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet availableNot yet available18.0.1
Production

Service 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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF640_ActivationConfiguration
NameService Activation & Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792872/TMF640_Service_Activation_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Activation & Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532402/TMF640B_Service_Activation_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Activation & Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF640-Service-Activation-And-Configuration_V4-0-0.zip?api=v2
NameService Activation & Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF640-ServiceActivation-v4.zip?api=v2
NameService Activation & Configuration API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF640-ServiceActivation-v4-Postman.zip?api=v2
NameService Activation & Configuration API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

Service Catalog API

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

TMF633


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF633_ServiceCatalog/releases/download/v3.0.0/TMF633-ServiceCatalog-3.0.0.swagger.json
NameService Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/110144709/TMF633_Service_Catalog_Management_API_REST_Specification_R18.5.0.pdf?api=v2
NameService Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/110144709/TMF633B_Service_Catalog_Management_API_Conformance_Profile_R18.5.0.pdf?api=v2
NameService Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://github.com/tmforum-rand/CTK-TMF633-ServiceCatalog/releases/download/18.5.0/CTK-TMF633-ServiceCatalog-R18-5.zip
NameService Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://github.com/tmforum-rand/RI-TMF633-ServiceCatalogManagement-R18-5
NameService Catalog Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF633-ServiceCatalog.zip
NameService Catalog Management API

 



Show If
special@anonymous


18.5.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF638_ServiceInventory
NameService Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792858/TMF638_Service_Inventory_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532378/TMF638B_Service_Inventory_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF638_Service_Inventory_V4-0-0.zip?api=v2
NameService Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF638-ServiceInventory-v4.zip?api=v2
NameService Inventory Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF638-ServiceInventory-v4-Postman.zip?api=v2
NameService Inventory Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF641_ServiceOrder/tree/master
NameService Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792876/TMF641_Service_Ordering_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532420/TMF641B_Service_Ordering_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF641_Service_Ordering_V4-0-0.zip?api=v2
NameService Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF641-ServiceOrdering-v4.zip?api=v2
NameService Ordering Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF641-ServiceOrdering-v4-Postman.zip?api=v2
NameService Ordering Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

Service Problem Management

The SPM API is used to manage service problems. Service problems are generated based on the information declared by a partner or the event information notified from infrastructure providers. The event information includes alarm information, performance anomaly information, trouble ticket information, SLA violation, maintenance information, and prediction information.

TMF656


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF656_ServiceProblemManagement/releases/download/v3.0.0/TMF656-ServiceProblem-3.0.0.swagger.json
NameService Problem Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/110144737/TMF656_Service_Problem_Management_API_REST_Specification_R18.5.0.pdf?api=v2
NameService Problem Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/110144737/TMF656B_Service_Problem_Management_API_Conformance_Profile_R18.5.0.docx?api=v2
NameService Problem Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://github.com/tmforum-rand/CTK-TMF656-ServiceProblem/releases/download/18.5.0/CTK-TMF656-ServiceProblem-R18-5.zip
NameService Problem Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://github.com/tmforum-rand/RI-TMF656-ServiceProblemManagement-R18-5
NameService Problem Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF656-ServiceProblem.zip
NameService Problem Management API

 



Show If
special@anonymous


18.5.1
Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF645_ServiceQualification/tree/master
NameService Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/134792885/TMF645_Service_Qualification_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532433/TMF645B_Service_Qualification_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF645_Service_Qualification_v4.0.0.zip?api=v2
NameService Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF645-ServiceQualification-v4.zip?api=v2
NameService Qualification API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF645-ServiceQualification-v4-Postman.zip?api=v2
NameService Qualification API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF657_ServiceQualityManagement
NameService Quality Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570274/TMF657_Service_Quality_Management_API_REST_Specification_R18.0.0.pdf?api=v2
NameService Quality Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570274/TMF657B_Service_Quality_Management_API_Conformance_Profile_R18.0.0.pdf?api=v2
NameService Quality Management API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available18.0.1
Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF653_ServiceTestManagement
NameService Test Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293787/TMF653_Service_Test_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameService Test Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146293791/TMF653B_Service_Test_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameService Test Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF653-ServiceTest_v4.0.0.zip?api=v2
NameService Test Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF653-ServiceTest-v4.zip?api=v2
NameService Test Management API

 



Show If
special@anonymous

 


 


Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF653-ServiceTest-v4.0.0.postman_collection.json.zip?api=v2
NameService Test Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF684_ShipmentTracking
NameShipment Tracking API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570324/TMF684_Shipment_Tracking_API_REST_Specification_R18.0.1.pdf?api=v2
NameShipment Tracking API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/96570324/TMF684B_Shipment_Tracking_Conformance_Profile_R18.0.1.pdf?api=v2
NameShipment Tracking API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available18.0.1
Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF663_ShoppingCart
NameShopping Cart API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080623/TMF663_Shopping_Cart_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569390694789&api=v2
NameShopping Cart API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080623/TMF663B_Shopping_Cart_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569390695588&api=v2
NameShopping Cart API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF663-ShoppingCart_v4.0.0.zip?api=v2
NameShopping Cart API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080623/implementation.zip?version=1&modificationDate=1569390694238&api=v2
NameShopping Cart API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080623/postman.zip?version=1&modificationDate=1569390694439&api=v2
NameShopping Cart API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


 

CTK Updated


Production

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
special@authenticated


Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/slaManagement/v2/swagger2.json
NameSLA Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF623_SLA_Management_API_REST_Specification_R14.5.1%202015.pdf
NameSLA Management API

 



Show If
special@anonymous


Not yet availableNot yet available


Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSMSLAAPI/tree/develop
NameSLA Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFSLAManagementAPI.json.postman_collection
NameSLA Management API

 



Show If
special@anonymous


14.5.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF621_TroubleTicket
NameTrouble Ticket API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080635/TMF621_Trouble_Ticket_API_REST_Specification_R19.0.0.pdf?version=1&modificationDate=1569387996274&api=v2
NameTrouble Ticket API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080635/TMF621B_Trouble_Ticket_Conformance_Profile_R19.0.0.pdf?version=1&modificationDate=1569387996829&api=v2
NameTrouble Ticket API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080635/CTK-TMF621-Trouble_Ticket-4.0.0.zip?version=1&modificationDate=1569387995742&api=v2
NameTrouble Ticket API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080635/implementation.zip?version=1&modificationDate=1569387995980&api=v2
NameTrouble Ticket API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/123080635/postman.zip?version=1&modificationDate=1569387996139&api=v2
NameTrouble Ticket API

 



Show If
special@anonymous


19.0.1

(v4.0.0)


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


Show If
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF677_UsageConsumption/releases/download/v3.0.0/TMF677-UsageConsumption-3.0.0.swagger.json
NameUsage Consumption API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/110148728/TMF677_Usage_Consumption_API_REST_Specification_R18.5.0.pdf?api=v2
NameUsage Consumption API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/110148728/TMF677B_Usage_Consumption_API_REST_Conformance_Profile_R18.5.0.docx?api=v2
NameUsage Consumption API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
LicenceRAND
Linkhttps://github.com/tmforum-rand/CTK-TMF677-UsageConsumption/releases/download/18.5.0/CTK-TMF677-UsageConsumption-R18-5.zip
NameUsage Consumption API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
LicenceRAND
Linkhttps://github.com/tmforum-rand/RI-TMF677-UsageConsumption-R18-5
NameUsage Consumption API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://github.com/tmforum-rand/PM-PostmansR18-5/releases/download/18.5.0/PM-TMF677-UsageConsumption.zip
NameUsage Consumption API

 



Show If
special@anonymous


18.5.1
 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF635_UsageManagement
NameUsage Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532412/TMF635_Usage_Management_API_User_Guide_v4.0.0.pdf?api=v2
NameUsage Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532416/TMF635B_Usage_Management_API_Conformance_Profile_v4.0.0.pdf?api=v2
NameUsage Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK
Linkhttps://projects.tmforum.org/wiki/download/attachments/143532500/TMF635_Usage_V4-0-0-fixed.zip?api=v2
NameUsage Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeRI
Linkhttps://projects.tmforum.org/wiki/download/attachments/146277001/TMF635-Usage-v4.zip?api=v2
NameUsage Management API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypePostman
LicenceRAND
Linkhttps://projects.tmforum.org/wiki/download/attachments/143534323/TMF635-Usage-v4-Postman.zip?api=v2
NameUsage Management API

 



Show If
special@anonymous


20.5.0

(v4.0.0)


 Production

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
special@authenticated


Trackinglink
TypeSwagger
LicenceApache 2.0
Linkhttps://github.com/tmforum-apis/TMF672_UserRolesPermissions
NameUser Roles & Permissions API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/90514834/TMF672_User_Roles_and_Permissions_API_REST_Specification_R17.0.1.pdf?api=v2
NameUser Roles & Permissions API

 



Show If
special@anonymous



Show If
special@authenticated


Trackinglink
TypeCTK-Conformance
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF672B_User_Roles_Permissions_API_Conformance_Profile_R17.0.docx?api=v2
NameUser Roles & Permissions API

 



Show If
special@anonymous


Not yet availableNot yet availableNot yet available17.0.1
 Production