Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 292 Next »

  

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.

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


To access the API table links below you will need to be logged in

To login with your TM Forum account please click on the Login button below

Login

Don't have an account? You can register by clicking here:

Register

TM Forum Open APIs

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

TM Forum Open APIs

API Specification

Postman Collection

Swagger and Swagger_UI

Reference Implementation Code

Download PDF Specification

Conformance

Profile and CTK

Release StatusRelease version

Account Management API

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

Coming soonComing soonReleased (New)17.0.0

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.

Coming soonReleased15.5.1

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.

Coming soonReleased16.0.1

Agreement Management API

  The Agreement API provides standardized mechanism for managing agreements, especially in the context on partnerships between partners.

Coming soonReleased16.0.1

Alarm Management API

The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces.

Coming soonComing soonReleased (New)17.0.0

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..

Coming soonReleased16.0.1

Billing Management API

Provides standardized mechanisms for billing account, bill item and settlement note advice management either in B2B or B2B2C contexts. 

Coming soonReleased14.5.1

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.

Coming soon

 

Coming soonComing soonReleased16.5.1

Customer Management API

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

Released14.5.1

Customer Management API

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

Coming soonComing soonReleased (New)17.0.0

Document Management API

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

Coming soonComing soonReleased (New)17.0.0

Entity Catalog Management API

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.

Coming soonComing soonReleased (New)17.0.0

Loyalty Management API

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

Coming soonReleased (New)17.0.0

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

Coming soonComing soonComing soonReleased15.5.0

Onboarding Management 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.

Coming soonReleased16.0.0

Partnership Type Management API

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.

Coming soonComing soonReleased (New)17.0.0

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. 

Coming soonReleased14.5.0

Party Role Management API

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

Coming soonComing soon Released (New)17.0.0 

Payment Methods API

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

Coming soon

Coming soon

 

Coming soon

Coming soon

 

Released (New)17.0.0

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. 

Coming soonComing soonComing soonReleased14.5.1

Performance Management Threshold 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 allows also notification of events related to performance

Coming soonComing soonComing soonReleased (New)17.0.0

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.

Coming soonComing soonReleased (New)17.0.0

Privacy Management 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..

Coming soonReleased16.0.1

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. 

Released14.5.1

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.

Released16.5.1

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.

Coming soonReleased16.5.1

Promotion API

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

Coming soonComing soonReleased (New)17.0.0

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.

Coming soonReleased16.0.1

Resource Catalog Management API

The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process.

Coming soonComing soonReleased (New)17.0.0

Resource Function Activation and Configuration API

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

Coming soonComing soonReleased (New)17.0.0

Resource Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory.

Coming soonComing soonReleased (New)17.0.0

Resource Ordering Management 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.

Coming soonComing soonComing soonComing soonReleased16.5.1

Service Catalog API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

Coming soonComing soonComing soonReleased16.5.1

Service Inventory Management API

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.

Coming soonComing soonComing soonComing soonReleased16.5.1

Service Ordering Management 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.

Coming soonComing soonComing soonComing soonReleased16.5.1

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.

Coming soonComing soon

Coming soon

Coming soonReleased16.5.1

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.

Released16.0.1

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.

Coming soonComing soonComing soonReleased16.5.1

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.

Coming soonComing soonComing soonReleased16.5.1

Shopping Cart API

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.

Coming soonComing soonReleased (New)17.0.0

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.

 

 

Coming soonReleased14.5.1

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).

Released14.5.1

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.

Coming soonReleased14.5.1

User Roles & Permissions API

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

Coming soonComing soonReleased (New)17.0.0

 

 

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

TM Forum Open APIs Early Adopters

API Specification

Postman Collection

Swagger and Swagger_UI

Reference Implementation Code

Download PDF Specification

Conformance

Profile and CTK

Release StatusRelease version

Communication API

Provides a capability to create and send communications, notifications and instructions to Parties, Individuals, Organizations or Users.

Coming soon


Coming soon

Beta17.5.0

Customer Bill Management API

This API allows operations to find and retrieve one or several customer bills (also called invoices) produced for a customer also allows operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

Coming soon 

 Coming soon 

Beta17.5.0

Geographic Address Management API

Provides a standardized client interface to an Address management system. It allows looking for worldwide addresses. It can also be used to validate geographic address data, to be sure that it corresponds to a real geographic address. Finally, it can be used to look for a geographic address by: searching an area as a start (city, town ...), then zooming on the streets of this area, and finally listing all the street segments (numbers) in a street.

Coming soon  

 Coming soon 

Beta17.5.0

Geographic Location Management API

Provides the information of geographic region of the entity (customer, equipment, address).

 Coming soon 

Coming soon  

Beta17.5.0

Geographic Site Management API

Covers the operations to manage (create, read, delete) sites that can be associated to a customer, account, service delivery or other entities. This API defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the  entity that can answer the question “where?”, allowing to determine where things are in relation to the earth's surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a  spatial reference system (geographic location)

Coming soon  

Coming soon  

Beta17.5.0

Payment Management API

This API allows the following operations. Notify of a performed payment, retrieve a list of payments filtered by a given criteria, retrieve a single performed payment, notify of a performed refund, retrieve a list of refunds filtered by a given criteria and retrieve a single performed refund.

Coming soon

Coming soon

Beta17.5.0

Product Catalog Management API

The catalog management API allows the management of the entire lifecycle of the catalog elements, the consultation of catalog elements during several processes such as ordering process, campaign management and sales management.

Coming soon 

Coming soon 

 Beta17.5.0 

Quote Management API

The customer Quote API provides a standardized mechanism for placing a customer quote with all of the necessary quote parameters. The API consists of a simple set of operations that interact with CRM/Order Negotiation systems in a consistent manner. A customer quote is created based on a product offer that is defined in a catalog.

Coming soon

Coming soon

Beta17.5.0

Recommendation API

Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.

Coming soon

Coming soon

Beta17.5.0

Service Catalog Management API

The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements.

Coming soon

Coming soon

Beta17.5.0

Usage Consumption Management API

This API should allow to view in real-time the balance of the various buckets (SMS, Voice, Data for example) that an user consumes with each of his devices and the usages done out of the bucket. An usage report retrieve the data related to these balances. This API should also allow to perform a direct topup on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfered.

Coming soon

Coming soon

Beta17.5.0

 

 

 

 

  • No labels