TM Forum Ecosystem API Portal

Space shortcuts

Page tree

Versions Compared

Old Version 7

changes.mady.by.user Unknown User ([email protected])

Saved on

compared with

New Version 8

changes.mady.by.user Unknown User ([email protected])

Saved on

Key

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

...

Released TM Forum Open APIs R17.0

API Specification

Postman Collection

Swagger

Swagger_UI

Reference Implementation Code

Download Specification

CTK

Profile

Account Management

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

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF666+Account+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
N/AN/AN/A

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740309/TMF666_Account_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

N/A

Customer Management

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

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF629+Customer+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
   

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740328/TMF629_Customer_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

N/A

Document Management

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

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF667+Document+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
N/AN/AN/A

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740359/TMF667_Document_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

N/A

Entity Catalog Management


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 managements of the entity specifications and their associations thru CRUD operations.

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF662+Entity+Catalog+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
N/AN/AN/A

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740219/TMF662_Entity_Catalog_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

N/A

Loyalty Management

Supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF658+Loyalty+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
N/AN/AN/A

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740366/TMF658_Loyalty_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

N/A

Partnership Type Management

Standardized mechanisms for creating partnership types. It is one of the APIs involved in an onboarding process. Identifies a type of a partnership between parties, including the list of role types that are permitted (i.e Buyer, Seller, Developper). Role types may refer to agreement specifications to be signed by parties playing the role.
The API allows the retrieval, creation, update and deletion of partnership type and its owned sub-resources.

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF668+Partnership+Type+Management++API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
  N/AN/AN/A 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740335/TMF668_Partnership_Type_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

 

Party Role Management

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

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF669+Party+Role+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
  N/AN/AN/A 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740343/TMF669_Party_Role_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

 

Payment Methods

This API supports the frequently-used payment methods for the customer to choose and pay the usage, including voucher card, coupon and money transfer.

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF670+Payment+Methods+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
  N/AN/AN/A 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740299/TMF670_Payment_Methods_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

 

Prepay Balance Management

Prepay API manages the balance, recharge (top-up) and transfer resources

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF654+Prepay+Balance+Management+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
  N/AN/AN/A 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740355/TMF654_Prepay_Balance_Management_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

 

Promotion

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

 

Show If

 

special

 

@authenticated

   

Resource Function Activation and Configuration

 

      

Shopping Cart

 

      

HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMFxxx+Promotion+API++REST+Specification+R17.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
Image Added
N/AN/AN/A

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740351/TMF671_Promotion_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

Image Added

 

Resource Function Activation and Configuration

 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF664+Resource+Function+Activation+and+Configuration+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
Image Added
   

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740169/TMF664_Resource_Function_Activation_and_Configuration_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

Image Added

 

Shopping Cart

 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF663+Shopping+Cart+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
Image Added
   

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740067/TMF663_Shopping_Cart_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

Image Added

 

User Roles & Permissions

 

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/display/AP/TMF672+User+Roles+and+Permissions+API+REST+Specification+R17.0.0');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/blueLinkCircle.png?version=1&amp;modificationDate=1444220863000&amp;api=v2"></a>

Show If
special@anonymous
Image Added
   

Show If
special@authenticated
HTML
<a href="javascript:trackclick('https://projects.tmforum.org/wiki/download/attachments/81740268/TMF672_User_Roles_and_Permissions_API_REST_Specification_R17.0.0.pdf?api=v2');"><img class="confluence-embedded-image confluence-thumbnail" width="40" src="/wiki/download/thumbnails/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2" data-image-src="/wiki/download/attachments/40177889/PDFRound.png?version=1&amp;modificationDate=1444222720000&amp;api=v2"></a>
Show If
special@anonymous

Image Added

User Roles & Permissions

 

     

 
       
HTML
<script type="text/javascript">
function trackclick(url,type,api){
	woopra.track("click", {
    	"document type": type,
    	title: api,
		"strategic program": "Open API Program",
		program: "API Project",
		topic: "API",
		app: "Confluence",
		permalink: url
		
	}
,redirect(url)
);
//	alert("will redirect to " + url);
}
 function redirect(url){
	window.open(url);
}
 
</script>

...