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
...
| numbering | Dynamic Ascending |
|---|
| sparkName | Sparkline |
|---|
| datepattern | yy-mm-dd |
|---|
| id | 1503488057316_-8476344 |
|---|
| sort | Released TM Forum Open APIs (Asc) |
|---|
| isOR | AND |
|---|
| separator | Point (.) |
|---|
...
API Specification
...
Swagger
Swagger_UI
...
Reference Implementation Code
...
Download Specification
...
CTK
Profile
...
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 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.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF640_Activation_Configuration_API_REST_Specification_R15.5.1-3.pdf |
|---|
| Name | Activation Configuration API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSSERVICEACTIVATION/blob/master/TMF%252520ActivationandConfiguration%252520API.json.postman_collection |
|---|
| Name | Activation Configuration API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/DSSERVICEACTIVATION/blob/master/tmforum-ActivationandConfigurationAPI-1.0-swagger.json','Swagger','Activation Configuration API |
|---|
| Name | Activation and Configuration API |
|---|
| |
| Trackinglink |
|---|
| Type | SwaggerUI |
|---|
| Link | https://swaggerhub.com/api/tmforum/ActivationandConfigurationAPI/1.0','SwaggerUI','Activation Configuration API |
|---|
| Name | Activation and Configuration API |
|---|
| |
|
...
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF640_Activation_Configuration_API_REST_Specification_R15.5.1-3.pdf |
|---|
| Name | Activation and Configuration API |
|---|
| |
|
...
Address API
The Address API is one of the Pre-Ordering Management APIs. The Address API provides a standardized client interface to an Address management system .It allows to look for worldwide addresses. It can also be used to validate address data, to be sure that it corresponds to a real address.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Link | https://projects.tmforum.org/wiki/display/PUB/TMF647+Address+API+REST+Specification+R16.0.1 |
|---|
| Name | Address API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSADDRESS/blob/master/AddressManagementAdmin.json.postman_collection |
|---|
| Name | Address API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/DSADDRESS/blob/master/tmforum-Address-1.0-swagger.json |
|---|
| Name | Address API |
|---|
| |
| Trackinglink |
|---|
| Type | SwaggerUI |
|---|
| Link | https://app.swaggerhub.com/apis/tmforum/Address/1.0 |
|---|
| Name | Address API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | 'https://github.com/tmforum/DSADDRESS','RI','Address API' |
|---|
| Name | Address API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF647_Address_API_REST_Specification_R16.0.2.pdf |
|---|
| Name | Address API |
|---|
| |
|
...
Agreement API
The Agreement API provides standardized mechanism for managing agreements, especially in the context on partnerships between partners.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Link | https://projects.tmforum.org/wiki/display/AP/TMF640+Activation+and+Configuration+API+REST+Specification+R15.5.0 |
|---|
| Name | Agreement API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSAGREEMENT/blob/master/Agreement_Management.postman.json |
|---|
| Name | Agreement API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/DSAGREEMENT/blob/master/Agreement_Management.regular.swagger.json |
|---|
| Name | Agreement API |
|---|
| |
| Trackinglink |
|---|
| Type | SwaggerUI |
|---|
| Link | https://app.swaggerhub.com/apis/tmforum/AgreementAPI/1.0 |
|---|
| Name | Agreement API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | 'https://github.com/tmforum/DSAGREEMENT','RI','Agreement API' |
|---|
| Name | Agreement API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF651_Agreement_Management_API_REST_Specification_R16.0.1.pdf |
|---|
| Name | Agreement API |
|---|
| |
|
...
Appointment API
The Appointment API is one of the Pre-Ordering Management APIs. The appointment API provides a standardized mechanism to book an appointment with all the necessary appointment characteristics. First, the API consists in searching free slots based on parameters, as for example a party. Then, the appointment is created. The appointment has characteristics such as nature of appointment, place of appointment..
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Link | https://projects.tmforum.org/wiki/display/AP/TMF646_Appointment_API_REST_Specification_R17.0 |
|---|
| Name | Appointment API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSAPPOINTMENT/blob/master/AppointementManagement.json.postman_collection |
|---|
| Name | Appointment API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/DSAPPOINTMENT/blob/master/tmforum-Appointment-1.0-swagger.json |
|---|
| Name | Appointment API |
|---|
| |
| Trackinglink |
|---|
| Type | SwaggerUI |
|---|
| Link | https://app.swaggerhub.com/apis/tmforum/Appointment/1.0 |
|---|
| Name | Appointment API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | 'https://github.com/tmforum/DSAPPOINTMENT','RI','Appointment API' |
|---|
| Name | Appointment API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF646_Appointment_API_REST_Specification_R16.0.2.pdf |
|---|
| Name | Appointment API |
|---|
| |
|
...
Billing Management API
Provides standardized mechanisms for billing account, bill item and settlement note advice management either in B2B or B2B2C contexts.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Link | https://projects.tmforum.org/wiki/display/API/Billing+Management+API+REST+Specification+%28TMF636%29+R14.5.1 |
|---|
| Name | Billing Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | https://github.com/tmforum/DSBILLINGMANAGEMENT/blob/develop/billingManagement.json.postman_collection |
|---|
| Name | Billing Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/billingManagement/v2/swagger2.json |
|---|
| Name | Billing Management API |
|---|
| |
| Trackinglink |
|---|
| Type | SwaggerUI |
|---|
| Link | 'http://repo-api.kermit.orange-labs.fr/swagger-ui/?url=http://repo-api.kermit.orange-labs.fr/apis/snapshot/tmf/billingManagement/v2/swagger2.json','SwaggerUI','Billing Management API' |
|---|
| Name | Billing Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | 'https://github.com/tmforum/DSBILLINGMANAGEMENT','RI','Billing Management API' |
|---|
| Name | Billing Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | 'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF636_Billing_Management_API_REST_Specification_R14.5.1%202015.pdf?version=1&modificationDate=1444748684000&api=v2','Specification PDF','Billing Management API' |
|---|
| Name | Billing Management API |
|---|
| |
|
...
Change Management API
The Change Management API provides the standard integration capabilities between external applications and Change Management Application. The API consists of a simple set of operations that interact with Change Request in a consistent manner. A Change Request is an IT service management discipline.
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Link | 'https://projects.tmforum.org/wiki/display/AP/TMF655+Change+Management+API+REST+Specification+R16.5.0' |
|---|
| Name | Change Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | 'https://projects.tmforum.org/wiki/download/attachments/71733999/TMF655_Change_Management_API_REST_Specification_R16.5.0.pdf?api=v2' |
|---|
| Name | Change Management API |
|---|
| |
|
...
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 |
|---|
|
| Trackinglink |
|---|
| Link | 'https://projects.tmforum.org/wiki/display/API/Customer+Management+API+REST+Specification+%28TMF629%29+R14.5.1','Specification','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Postman |
|---|
| Link | 'https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFCustomerManagementAPI.json.postman_collection','Postman','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Swagger |
|---|
| Link | 'https://github.com/tmforum/TMFAPISWAGGER/blob/develop/customerManagement/v2/swagger2.json','Swagger','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
| Trackinglink |
|---|
| Type | SwaggerUI |
|---|
| Link | 'http://repo-api.kermit.orange-labs.fr/swagger-ui/?url=http://repo-api.kermit.orange-labs.fr/apis/snapshot/tmf/customerManagement/v2/swagger2.json','SwaggerUI','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | RI |
|---|
| Link | 'https://github.com/tmforum/DSCUSTOMER','RI','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | Specification PDF |
|---|
| Link | 'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF629_Customer_Management_API_REST_Specification_R14.5.1%202015.pdf?version=1&modificationDate=1444748481000&api=v2','Specification PDF','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
|
...
| Show If |
|---|
|
| Trackinglink |
|---|
| Type | CTK |
|---|
| Link | 'https://github.com/tmforum/CUSTOMERMANAGEMENT-CTK/archive/master.zip','CTK','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
| Trackinglink |
|---|
| Type | CTK-Conformance |
|---|
| Link | 'https://github.com/tmforum/CUSTOMERMANAGEMENT-CTK/raw/master/TMF659_Customer_Management_API_Conformance_Profile_R16.5.0.pdf','CTK-Conformance','Customer Management API' |
|---|
| Name | Customer Management API |
|---|
| |
|
...
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.
...
...
...
NFV Entity Provisioning API
REST API for NFV Entity Provisioning i.e. provisioning and lifecycle management of Network Services composed from Physical and Virtual Network Functions
...
...
...
Onboarding API
The Onboarding API provides standardized mechanisms for managing an onboarding process. The API allows the retrieval, creation, update and deletion of partnership type and its owned sub- resources.The intention for partner onboarding in the Digital Ecosystem is to have a lightweight approach similar to an end-user signing-on to terms and conditions for downloadable applications. The onboarding of the “Party”, the role can be Partner, Supplier, Developer, etc. The onboarding of the “Services” could be product offerings.
...
...
...
...
...
...
...
...
Party Management API
Provides a standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events. A Party can be an individual or an organization that has any kind of relation with the enterprise.
...
...
...
...
...
...
...
...
...
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.
...
...
...
...
...
...
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.
...
...
...
Privacy API
The Privacy management API provides standardized mechanism for privacy profile types, privacy profiles and privacy agreements such as creation, update, retrieval, deletion and notification of events..
...
...
...
...
...
...
...
...
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.
...
...
...
...
...
...
...
...
...
...
...
Image Removed
...
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.
...
...
...
...
...
...
...
...
...
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.
...
...
...
...
...
...
...
...
Quote 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.
...
...
...
...
...
...
...
Resource Ordering 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.
...
...
...
Service Catalog API
The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.
...
...
...
...
...
Service Ordering 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.
...
...
...
Service Problem Management API (SPM)
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.
...
...
...
...
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.
...
...
...
...
...
...
...
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.
...
...
...
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.
...
...
...
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.
...
...
...
...
...
...
...
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).
...
...
...
...
...
...
...
...
...
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.
...
...
...
...
...
...
...
| numbering | Dynamic Ascending |
|---|
| sparkName | Sparkline |
|---|
| datepattern | yy-mm-dd |
|---|
| id | 1503487955574_1906195131 |
|---|
| sort | TM Forum Open APIs R17.0 (Asc) |
|---|
| isOR | AND |
|---|
| separator | Point (.) |
|---|
...
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
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.
...
...
...
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
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
...
...
...
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
...
...
...
