Versions Compared

Key

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

...

Table Filter
numberingDynamic Ascending
sparkNameSparkline
datepatternyy-mm-dd
id1503488057316_-8476344
sortReleased TM Forum Open APIs (‍Asc)
isORAND
separatorPoint (.)
Released TM Forum Open APIs

API Specification

Postman Collection

Swagger

Swagger_UI

Reference Implementation Code

Download Specification

CTK

Profile

Release versionComments

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
special@authenticated

Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/40177889/TMF640_Activation_Configuration_API_REST_Specification_R15.5.1-3.pdf
NameActivation Configuration API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/DSSERVICEACTIVATION/blob/master/TMF%252520ActivationandConfiguration%252520API.json.postman_collection
NameActivation Configuration API

 

Show If
special@anonymous

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/DSSERVICEACTIVATION/blob/master/tmforum-ActivationandConfigurationAPI-1.0-swagger.json','Swagger','Activation Configuration API
NameActivation and Configuration API

 

Trackinglink
TypeSwaggerUI
Linkhttps://swaggerhub.com/api/tmforum/ActivationandConfigurationAPI/1.0','SwaggerUI','Activation Configuration API
NameActivation and Configuration API

 

Show If
special@anonymous

 

Show If
special@authenticated
Trackinglink
TypeRI
Linkhttps://github.com/tmforum/DSSERVICEACTIVATION
NameActivation and Configuration API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Link'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF640_Activation_Configuration_API_REST_Specification_R15.5.1-3.pdf?version=1&modificationDate=1462215410000&api=v2','Specification PDF','Activation Configuration API'
NameActivation and Configuration API

 

Show If
special@anonymous

N/A16.0.0 

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
special@authenticated
Trackinglink
Linkhttps://projects.tmforum.org/wiki/download/attachments/64258375/TMF647_Address_API_REST_Specification_R16.0.0.pdf?api=v2
NameAddress API

 

Show If
special@anonymous

 

 

 

 

Show If
special@authenticated
Trackinglink
TypePostman
Linkhttps://github.com/tmforum/DSADDRESS/blob/master/AddressManagementAdmin.json.postman_collection
NameAddress API

 

Show If
special@anonymous

Show If
special@authenticated
Trackinglink
TypeSwagger
Link'https://github.com/tmforum/DSADDRESS/blob/master/tmforum-Address-1.0-swagger.json','Swagger','Address API'
NameAddress API

 

Trackinglink
TypeSwaggerUI
Link'https://app.swaggerhub.com/apiapis/tmforum/Address/1.0','SwaggerUI','Address API'
NameAddress API

 

Show If
special@anonymous

 

Show If
special@authenticated
Trackinglink
TypeRI
Link'https://github.com/tmforum/DSADDRESS','RI','Address API'
NameAddress API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Link'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF647_Address_API_REST_Specification_R16.0.2.pdf?version=1&modificationDate=1479333278000&api=v2','Specification PDF','Address API'
NameAddress API

 

Show If
special@anonymous

N/A16.0.1 

Agreement API

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

Show If
special@authenticated
Trackinglink
Link'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF651_Agreement_Management_API_REST_Specification_R16.0.1.docx?version=2&modificationDate=1479332839000&api=v2','Specification','Agreement%20API'
NameAgreement API

 

Show If
special@anonymous

 

 

 

 

Show If
special@authenticated
Trackinglink
TypePostman
Link'https://github.com/tmforum/DSAGREEMENT/blob/master/Agreement_Management.postman.json','Postman','Agreement API'
NameAgreement API

 

Show If
special@anonymous

Show If
special@authenticated
Trackinglink
TypeSwagger
Link'https://github.com/tmforum/DSAGREEMENT/blob/master/Agreement_Management.regular.swagger.json','Swagger','Agreement API'
NameAgreement API

 

Trackinglink
TypeSwaggerUI
Link'https://swaggerhub.com/api/tmforum/AgreementAPI/1.0','SwaggerUI','Agreement API'
NameAgreement API

 

Show If
special@anonymous

 

Show If
special@authenticated
Trackinglink
TypeRI
Link'https://github.com/tmforum/DSAGREEMENT','RI','Agreement API'
NameAgreement API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Link'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF651_Agreement_Management_API_REST_Specification_R16.0.1.pdf?version=2&modificationDate=1479332826000&api=v2','Specification PDF','Agreement%20API'
NameAgreement API

 

Show If
special@anonymous

N/A16.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..

Show If
special@authenticated
Trackinglink
Link'https://projects.tmforum.org/wiki/download/attachments/40177889/SPM%20API%20RESTSpec_V0-0-1_161020-1.pdf?version=1&modificationDate=1477333456000&api=v2','Specification','Appointment%20API'
NameAppointment API

 

Show If
special@anonymous

 

 

 

 

Show If
special@authenticated
Trackinglink
TypePostman
Link'https://github.com/tmforum/DSAPPOINTMENT/blob/master/AppointementManagement.json.postman_collection','Postman','Appointment API'
NameAppointment API

 

Show If
special@anonymous

 

 

Show If
special@authenticated
Trackinglink
TypeSwagger
Linkhttps://github.com/tmforum/DSAPPOINTMENT/blob/master/api-appointment.swagger-2.json','Swagger','Appointment API'
NameAppointment API

 

Trackinglink
TypeSwaggerUI
Link'https://swaggerhub.com/api/tmforum/Appointment/1.0','SwaggerUI','Appointment API'
NameAppointment API

 

Show If
special@anonymous

 

Show If
special@authenticated
Trackinglink
TypeRI
Link'https://github.com/tmforum/DSAPPOINTMENT','RI','Appointment API'
NameAppointment API

 

Show If
special@anonymous

 

 

Show If
special@authenticated
Trackinglink
TypeSpecification PDF
Link'https://projects.tmforum.org/wiki/download/attachments/40177889/TMF646_Appointment_API_REST_Specification_R16.0.2.pdf?version=1&modificationDate=1478611775000&api=v2','Specification PDF','Appointment API'
NameAppointment API

 

Show If
special@anonymous

N/A16.0.1 

Billing Management API

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

Show If
special@authenticated
Trackinglink
Link'https://projects.tmforum.org/wiki/display/API/Billing+Management+API+REST+Specification+%28TMF636%29+R14.5.1','Specification','Billing Management API'
NameBilling Management API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypePostman
Link'https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFBillingAPI.json.postman_collection','Postman','Billing Management API'
NameBilling Management API

 

Show If
special@anonymous

 

 

Show If
special@authenticated
Trackinglink
TypeSwagger
Link'https://github.com/tmforum/TMFAPISWAGGER/blob/develop/billingManagement/v2/swagger2.json','Swagger','Billing Management API'
NameBilling Management API

 

Trackinglink
TypeSwaggerUI
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'
NameBilling Management API

 

Show If
special@anonymous

 

Show If
special@authenticated
Trackinglink
TypeRI
Link'https://github.com/tmforum/DSBILLINGMANAGEMENT','RI','Billing Management API'
NameBilling Management API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypeSpecification 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'
NameBilling Management API

 

Show If
special@anonymous

N/A14.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.

Show If
grouptmforum-members

Trackinglink
Link'https://projects.tmforum.org/wiki/display/AP/TMF655+Change+Management+API+REST+Specification+R16.5.0'
NameChange Management API

 

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members
Trackinglink
TypeSpecification PDF
Link'https://projects.tmforum.org/wiki/download/attachments/71733999/TMF655_Change_Management_API_REST_Specification_R16.5.0.pdf?api=v2'
NameChange Management API

 

Show If
special@anonymous

N/A16.5.0 

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
special@authenticated
Trackinglink
Link'https://projects.tmforum.org/wiki/display/API/Customer+Management+API+REST+Specification+%28TMF629%29+R14.5.1','Specification','Customer Management API'
NameCustomer Management API

 

Show If
special@anonymous

 

 

Show If
special@authenticated
Trackinglink
TypePostman
Link'https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFCustomerManagementAPI.json.postman_collection','Postman','Customer Management API'
NameCustomer Management API

 

Show If
special@anonymous

 

 

Show If
special@authenticated
Trackinglink
TypeSwagger
Link'https://github.com/tmforum/TMFAPISWAGGER/blob/develop/customerManagement/v2/swagger2.json','Swagger','Customer Management API'
NameCustomer Management API

 

Trackinglink
TypeSwaggerUI
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'
NameCustomer Management API

 

Show If
special@anonymous

Show If
special@authenticated
Trackinglink
TypeRI
Link'https://github.com/tmforum/DSCUSTOMER','RI','Customer Management API'
NameCustomer Management API

 

Show If
special@anonymous

 

 

 

Show If
special@authenticated
Trackinglink
TypeSpecification 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'
NameCustomer Management API

 

Show If
special@anonymous

Show If
special@authenticated
Trackinglink
TypeCTK
Link'https://github.com/tmforum/CUSTOMERMANAGEMENT-CTK/archive/master.zip','CTK','Customer Management API'
NameCustomer Management API

 

Trackinglink
TypeCTK-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'
NameCustomer Management API

 

Show If
special@anonymous

14.4.1 

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.

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.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

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

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.

Show If
special@authenticated

Show If
special@anonymous

 

 

 

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

 

Show If
special@authenticated

Show If
special@anonymous

 

 

 

Show If
special@authenticated

Show If
special@anonymous

N/A16.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. 

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

Show If
special@authenticated

Show If
special@anonymous

 

 

 

Show If
special@authenticated

Show If
special@anonymous

N/A14.5.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. 

Show If
special@authenticated

Show If
special@anonymous

 

 

 

N/AN/A

Show If
special@authenticated

Show If
special@anonymous

 

 

 

Show If
special@authenticated

Show If
special@anonymous

N/A14.5.1 

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.

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

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

Show If
special@authenticated

Show If
special@anonymous

 

 

 

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

 

 

 

Show If
special@authenticated

Show If
special@anonymous

N/A16.0.0 

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. 

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

 

 

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

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

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

16.5.0 

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.

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

N/A16.5.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.

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

 

Show If
special@authenticated

Show If
special@anonymous

 

 

 

Show If
special@authenticated

Show If
special@anonymous

N/A16.0.0 

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.

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

Service Catalog API

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

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

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

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

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.

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

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.

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/A

N/A

 

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

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.

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

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

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.0 

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.

Show If
grouptmforum-members

Show If
special@anonymous

N/AN/AN/A

Show If
grouptmforum-members

Show If
special@anonymous

N/A16.5.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.

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

 

 

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous


 

 

Show If
special@authenticated

Show If
special@anonymous

N/A14.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).

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

 

 

Show If
special@authenticated

Show If
special@anonymous

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

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

 

Show If
special@authenticated

Show If
special@anonymous

Show If
special@authenticated

Show If
special@anonymous

N/A14.5.1 

...