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 |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/71731075/TMF658_Loyalty_API_REST_Specification_R16.5.0.docx?api=v2 |
---|
Name | Loyalty Management API |
---|
| |
|
| N/A | N/A | N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/71734052/TMF658%20Loyalty_API_REST_Specification_R16.5.0.pdf?api=v2 |
---|
Name | Loyalty Management API |
---|
| |
|
| N/A | 16.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 |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/Entity%20Provisioning%20v1.docx |
---|
Name | NFV Entity Provisioning API |
---|
| |
|
| N/A | N/A | N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/Entity%20Provisioning%20v1.pdf?version=1&modificationDate=1479339743000&api=v2 |
---|
Name | NFV Entity Provisioning API |
---|
| |
|
| N/A | 16.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 |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF650_Onboarding_Management_API_REST_Specification_R16.0.0.docx |
---|
Name | Onboarding API |
---|
| |
|
| Show If |
---|
| Trackinglink |
---|
Type | Postman |
---|
Link | https://github.com/tmforum/DSONBOARDING/blob/master/Onboarding_Management.postman.json |
---|
Name | Onboarding API |
---|
| |
|
| Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://github.com/tmforum/DSONBOARDING/blob/master/Onboarding_Management.regular.swagger.json |
---|
Name | Onboarding API |
---|
| |
Trackinglink |
---|
Type | SwaggerUI |
---|
Link | https://swaggerhub.com/api/tmforum/OnboardingAPI/1.0 |
---|
Name | Onboarding API |
---|
| |
|
| Show If |
---|
| Trackinglink |
---|
Type | RI |
---|
Link | https://github.com/tmforum/DSONBOARDING |
---|
Name | Onboarding API |
---|
| |
|
| Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF650_Onboarding_Management_API_REST_Specification_R16.0.0.pdf |
---|
Name | Onboarding API |
---|
| |
|
| N/A | 16.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 |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/display/API/Party+Management+API+REST+Specification+(TMF632)+R14.5.1 |
---|
Name | Party Management API |
---|
| |
| | Show If |
---|
| Trackinglink |
---|
Type | Postman |
---|
Link | https://github.com/tmforum/TMFAPIPOSTMAN/blob/master/TMFPartyManagementAPI.json.postman_collection |
---|
Name | Party Management API |
---|
| |
| | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://github.com/tmforum/TMFAPISWAGGER/blob/develop/partyManagement/v2/swagger2.json |
---|
Name | Party 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/partyManagement/v2/swagger2.json |
---|
Name | Party Management API |
---|
| |
|
| Show If |
---|
| Trackinglink |
---|
Type | RI |
---|
Link | https://github.com/tmforum/DSPARTYMANAGEMENT/tree/develop |
---|
Name | Party Management API |
---|
| |
| | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF632_Party_Management_API_REST_Specification_R14.5.1%202015.pdf |
---|
Name | Party Management API |
---|
| |
|
| N/A | 14.5.0 | Note: There is no Word document to download |
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 |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/display/API/Performance+Management+API+REST+Specification+%28TMF628%29+R14.5.1 |
---|
Name | Performance Management API |
---|
| |
| | N/A | N/A | Show If |
---|
| Trackinglink |
---|
Type | RI |
---|
Link | https://github.com/tmforum/DSMPMAPI/tree/dmapmapiv1.0/DSMPMAPIWP |
---|
Name | Performance Management API |
---|
| |
| | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF628_Performance_Management_API_REST_Specification_R14.5.1%202015.pdf |
---|
Name | Performance Management API |
---|
| |
|
| N/A | 14.5.1 | Note: There is no Word document to download |
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 |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF_Prepay-Recharge_API_REST_Specification_Proposal_v10draft_REVISION4_TMFORUMaftercomments.docx |
---|
Name | Prepay Balance Management API |
---|
| |
|
| N/A | N/A | N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/40177889/TMF_Prepay-Recharge_API_REST_Specification_Proposal_v10draft_REVISION4_TMFORUMaftercomments.pdf |
---|
Name | Prepay Balance Management API |
---|
| |
|
| N/A | 16.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.. | | | | | | N/A | 16.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. | | | | | | | 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. | | | | | | | 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. | | | | | | N/A | 16.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. | | | | | | N/A | 16.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. | | N/A | N/A | N/A | | N/A | 16.5.0 | |
Service Catalog API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | | N/A | N/A | N/A | | N/A | 16.5.0 | |
Service Inventory API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory. | | N/A | N/A | N/A | | N/A | 16.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. | | N/A | N/A | N/A | | N/A | 16.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. | | N/A | N/A | | | N/A | 16.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. | | | | | | | 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. | | N/A | N/A | N/A | | N/A | 16.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. | | N/A | N/A | N/A | | N/A | 16.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. | | | | | | N/A | 14.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). | | | | | | | 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. | | | | | | N/ |