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.
...
...
title | To 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 |
---|
title | Login |
---|
type | primary |
---|
url | https://projects.tmforum.org/wiki/login.action?os_destination=%2Fdisplay%2FAPI%2FOpen%2BAPI%2BTable |
---|
|
Don't have an account? You can register by clicking here:
...
...
Dialog |
---|
id | login-required |
---|
title | Login Required |
---|
|
Section |
---|
Panel |
---|
| To access the API documentation you need to be logged in to your TM Forum account Button Hyperlink |
---|
title | Login |
---|
type | primary |
---|
url | https://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 |
---|
title | Register |
---|
type | primary |
---|
url | https://www.tmforum.org/user-registration/ |
---|
target | true |
---|
|
|
|
|
Dialog |
---|
id | members-only |
---|
title | For TM Forum Members |
---|
|
Section |
---|
Panel |
---|
| Image Removed 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 |
---|
title | Browse Released APIs |
---|
type | primary |
---|
url | https://projects.tmforum.org/wiki/display/API/Open+API+Table#OpenAPITable-ReleasedTMForumOpenAPIs |
---|
|
Button Hyperlink |
---|
title | Find out more about Membership |
---|
type | standard |
---|
url | https://www.tmforum.org/membership/benefits/ |
---|
target | true |
---|
|
|
|
|
Released TM Forum Open APIs
...
API Specification
...
Swagger
Swagger_UI
...
Reference Implementation Code
...
Download Specification
...
CTK
Profile
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Image Removed
...
...
...
...
...
...
...
...
...
...
...
Image Removed
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Billing Management API
Provides standardized mechanisms for billing account, bill item and settlement note advice management either in B2B or B2B2C contexts.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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.
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
API Specification
...
Swagger
Swagger_UI
...
Reference Implementation Code
...
Download Specification
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
Show If |
---|
special | @authenticated |
---|
match | all |
---|
group | not-tmforum-members |
---|
|
Image Removed |
...
...
API Specification
...
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
...
...
...
Customer Management
Provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.
...
...
...
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
...
...
...
Entity Catalog Management
...
...
...
Loyalty Management
Supports the management of loyalty program specifications, loyalty program members, their associated products and loyalty accounts with loyalty balances
...
...
...
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.
...
...
...
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
...
...
...
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.
...
...
...
Prepay Balance Management
Prepay API manages the balance, recharge (top-up) and transfer resources
...
...
...
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
...
...
...
Resource Function Activation and Configuration
...
...
...
Shopping Cart
Standardized mechanism for the management of shopping carts. Including creation, update, retrieval, deletion and notification of event. Shopping Cart entity is used for the temporarily selection and reservation of product offerings in e-commerce and retail purchase. Shopping cart supports purchase of both tangible and intangible goods and service (e.g. handset, telecom network service). The charge includes the one-off fee such as the fee for handset and the recurring fee such as the fee of a network service. Shopping Cart contains list of cart items, a reference to party or party role (e.g. customer) or contact medium in case of unknown customer, In addition the calculated total items price including promotions.
...
...
...
User Roles & Permissions
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 roletype and the corresponding permissions are created for that user
...
...
...
...