About Us  |  Membership |  Help
Log In |  Register

tmforum.org

API Zone

API Zone


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.

Developers can use our new portal to get the full technical details on Open Digital APIs, try them out in a live environment, get sample apps, source code and more.

Downloadable specifications are also available for the following APIs:

  • The Billing Management API provides standardized mechanisms for billing account, bill item and settlement note advice management either in B2B or B2B2C contexts. 
  • The Customer Management API provides a standardized mechanism for customer and customer account management, such as creation, update, retrieval, deletion and notification of events.
  • The 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.
  • The Performance Management 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 also allows notification of events related to performance.
  • The 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. 
  • The 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.
  • The 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. 
  • The 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.
  • The 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).
  • The 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 retrieve usage generated by a partner service platform in order to rate it
    - To provide rated usage to a partner for consumption follow up purposes.


“The cloud services companies of all sizes... the cloud is for everyone. The cloud is a democracy.”

Marc Benioff, CEO - Salesforce.com