Versions Compared

Key

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

...

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. PLEASE NOTE:

This table contains the links to both Release and Beta versions of the Open APIs. 

Hide If
special@authenticated
Note
titleTo access the API table links below you wil 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

...

TM Forum Open APIs

default
Table Filter
inverse
order
cell-widthsparkNameSparkline
datepatternyy-mm-dd
id1505723127764_-762982114
sortTM Forum Open APIs (‍Asc)
isORAND
separatorPoint (.)labels
TM Forum Open APIs

API Specification

Postman Collection

Swagger and Swagger_UI

Reference Implementation Code

Download PDF Specification

Conformance

Profile and CTK

Frameworx Release versionRelease Status

Customer Management API

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

Show If
special@authenticated
Trackinglink
Linkhttps://projects.tmforum.org/wiki/display/API/Customer+Management+API+REST+Specification+%28TMF629%29+R14.5.1
NameCustomer Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFCustomerManagementAPI.json.postman_collection
NameCustomer Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/customerManagement/v2/swagger2.json
NameCustomer Management API

 

Trackinglink
TypeSwaggerUI
Linkhttp://repo-api.kermit.orange-labs.fr/swagger-ui/?url=http://repo-api.kermit.orange-labs.fr/apis/snapshot/tmf/customerManagement/v2/swagger2.json
NameCustomer Management API

 

Show If
special@anonymous

Image Modified

Image Modified

Show If
special@authenticated
Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSCUSTOMER
NameCustomer Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF629_Customer_Management_API_REST_Specification_R14.5.1%202015.pdf
NameCustomer Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypeCTK
Linkhttps://github.com/tmforum/CUSTOMERMANAGEMENT-CTK/archive/master.zip
NameCustomer Management API

 

Trackinglink
TypeCTK-Conformance
Linkhttps://github.com/tmforum/CUSTOMERMANAGEMENT-CTK/blob/master/TMF659_Customer_Management_API_Conformance_Profile_R16.5.0.pdf
NameCustomer Management API

 

Show If
special@anonymous

Image Modified

Image Modified

14.4.1Released

Loyalty Management API  

The Loyalty API supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances. The scope of the API also covers the management of loyalty rules and under what conditions the associated loyalty actions must be applied.

Show If
special@authenticated
Trackinglink
Linkhttps://projects.tmforum.org/wiki/display/PUB/TMF658+Loyalty+Management+API+REST+Specification+R16.5.1
NameLoyalty Management API

 

Show If
special@anonymous

Image Modified

N/A

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://projects.tmforum.org/wiki/download/attachments/73269493/LoyaltySwagger.json?api=v2
NameLoyalty Management API

 

Show If
special@anonymous

Image Modified

Image Modified

N/A

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/73269498/TMF658_Loyalty_API_REST_Specification_R16.5.1.pdf?api=v2
NameLoyalty Management API

 

Show If
special@anonymous

Image Modified

N/A16.5.1Released

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 balance from one account to another.

Show If
special@authenticated
Trackinglink
Linkhttps://projects.tmforum.org/wiki/display/PUB/TMF654+Prepay+Balance+Management+API+REST+Specification+R16.5.1
NamePrepay Balance Management API

 

Show If
special@anonymous

Image Modified

N/AN/AN/A

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/73269444/TMF654_Prepay_Balance_Management_API_REST_Specification_R16.5.1.pdf?api=v2
NamePrepay Balance Management API

 

Show If
special@anonymous

Image Modified

N/A16.5.1Released

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. 

Show If
special@authenticated
Trackinglink
Linkhttps://projects.tmforum.org/wiki/display/API/Product+Catalog+Management+API+REST+Specification+%28TMF620%29+R14.5.1
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFProductCatalogAPI.json.postman_collection
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/TMFAPISWAGGER/blob/develop/productCatalog/v2/swagger2.json
NameProduct Catalog Management API

 

Trackinglink
TypeSwaggerUI
Linkhttp://repo-api.kermit.orange-labs.fr/swagger-ui/?url=http://repo-api.kermit.orange-labs.fr/apis/snapshot/tmf/productCatalog/v2/swagger2.json
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Modified

Image Modified

Show If
special@authenticated
Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSPRODUCTCATALOG2/tree/master','RI','Product Catalog Management API
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Linkhttps://projects.tmforum.org/wiki/download/attachments/84575796/TMF620_Product_Catalog_Management_API_REST_Specification_R14.5.1%202015.pdf
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Modified

Show If
special@authenticated
Trackinglink
TypeCTK
Linkhttps://github.com/tmforum/PRODUCTCATALOG-CTK/archive/master.zip
NameProduct Catalog Management API

 

Trackinglink
TypeCTK-Conformance
Linkhttps://github.com/tmforum/PRODUCTCATALOG-CTK/raw/master/TMF660_Product_Catalog_API_Conformance_Profile_R16.5.0.pdf
NameProduct Catalog Management API

 

Show If
special@anonymous

Image Modified

Image Modified

14.5.1Released