API program

VERSION 22.5

sponsored by: *COMING SOON

- Open API map

TMF699 SALES MANAGEMENT
upskill on
MARKET / SALES

APIs here
Sales Management provides for Sales Lead, Sales
Opportunity, Sales Quote to support the sales activities
used to build a relationship with a prospective customer
(Individual or Organization) that has an interest in your
goods and/or services.

TMF646 APPOINTMENT MANAGEMENT TMF629 CUSTOMER MANAGEMENT TMF670 PAYMENT METHOD MANAGEMENT TMF622 PRODUCT ORDERING MANAGEMENT TMF680 RECOMMENDATION MANAGEMENT TMF663 SHOPPING CART MANAGEMENT
Appointment can be used to book an appointment with Customer is used to manage the Customer Account This API supports the frequently-used payment methods (aka payment Provides the ability to place a Product Order with all necessary order Recommendation is used to recommend personalized Product Offerings This API manages Shopping Carts including creation, update, retrieval,
relevant characteristics (nature of appointment, place etc). (a Party Role), such as creation, update, retrieval, means) for a Customer to choose and pay for usage, including credit-card, parameters, interacting with CRM/Order negotiation systems in a consistent based on the history and context of a Customer in real-time. It is usually deletion and notification of related events. A Shopping Cart is used for the
This allows searching of free slots based on parameters such deletion and notification of events. voucher, coupon, and money transfer. manner. A Product Order is based on a Product Offering that is defined in provided by omnichannel e-commerce or BSS, CRM systems. temporary selection and reservation of Product Offerings in e-commerce
as a party, then creating the appointment. a Product Catalog, which includes characteristics such as pricing, product and retail purchase.
CUSTOMER

options and market.

TMF678 CUSTOMER BILL MANAGEMENT TMF676 PAYMENT MANAGEMENT TMF654 PREPAY BALANCE MANAGEMENT TMF648 QUOTE MANAGEMENT TMF696 RISK MANAGEMENT
Customer Bill can be used to find and retrieve one or more The Payments API manages payments or refunds in Prepay Balance Management allows pre-paid subscribers to manage The Quote API allows for obtaining a quote with all the necessary quote Risk Management allows the retrieval of Risk Assessments during
customer bills (also called invoices) and to find and retrieve a Payment System. Payment API originators (clients) (view/top-up) Buckets of allowance before using services. Operators can parameters, from the Pre-Ordering Management APIs. interactions with PartyRoles (Individuals or Organizations) typically
the details of applied customer billing rates presented on a include Web servers, mobile app servers, Contact provide multiple recharge channels for subscribers, and subscribers can engaged in an Order process from ProviderPartyRole. The Risk Assessment
customer bill. center dashboards or retail store systems. transfer credit between different subscriptions. request is usually issued by the ProviderPartyRole (e.g. Service Provider).
The resources used to retrieve these assessments are Task resources, as per
the Open API guidelines for tasks.

TMF620 PRODUCT CATALOG MANAGEMENT TMF637 PRODUCT INVENTORY MANAGEMENT TMF679 PRODUCT OFFERING QUALIFICATION MANAGEMENT TMF671 PROMOTION MANAGEMENT TMF677 USAGE CONSUMPTION MANAGEMENT TMF635 USAGE MANAGEMENT
Provides a standardized solution for rapidly adding partners’ Product Inventory Management allows the Product Offering Qualification allows Product Offering commercial Promotion is used to provide an additional discount, voucher, bonus or Usage Consumption represents the real-time value within Buckets (SMS, Usage manages both rated and non-rated use of a Product or Service.
PRODUCT

products to an existing Catalog. This allows Service creation, partial or full update and retrieval of the eligibility in the Pre-Ordering Management API Family. gift to the customer who meets pre-defined criteria. It is used to attract Voice, Data, TV for example) that a Customer consumes with each of their For example, it allows a service provider to retrieve usage generated by a
Providers to directly feed partners systems with the technical representation of a Product in the Inventory. It also the users and encourage more consumption, especially continuous devices, related to subscribed Products without having to wait for the bill partner service platform in order to rate it; or to provide rated usage to a
description of the ProductOffering that they propose to allows the notification of events related to product purchases. It is often applied when the customer buys product offerings cycle. A Usage Consumption Report retrieves the data related to these partner for consumption follow-up purposes.
them. lifecycle. with the price or amount surpassing a certain limit. balances.

TMF640 SERVICE ACTIVATION MANAGEMENT TMF633 SERVICE CATALOG MANAGEMENT TMF638 SERVICE INVENTORY MANAGEMENT TMF656 SERVICE PROBLEM MANAGEMENT TMF657 SERVICE QUALITY MANAGEMENT
Activation and Configuration allows the user to retrieve, create, Service Catalog Management allows the management Service Inventory Management allows the query and manipulation of the Service problems are generated based on the information declared by a Service Quality manages Service Level Specifications and associated
update, delete services and retrieve the monitor resource used of the entire lifecycle of the service catalog elements. Service Inventory. partner or the event information notified from infrastructure providers. This Service Level Objectives (SLO) and their thresholds.
to monitor the execution of asynchronous requests on a specific may include alarms, performance anomalies, trouble tickets, SLA violations,
SERVICE

resource. Although the examples in the API specification are maintenance information, and predictions.
relative to Services, the same API can also be used to Activate
and Configure Resources.
TMF633 SERVICE CATALOG MANAGEMENT TMF641 SERVICE ORDERING MANAGEMENT TMF645 SERVICE QUALIFICATION MANAGEMENT TMF653 SERVICE TEST MANAGEMENT
Service Catalog Management allows the management Service Order Management provides for placing a Service Order with Service Qualification provides Service Availability at a Customer location, Service Test manages a Service Test with all the necessary test parameters.
of the entire lifecycle of the service catalog elements. all the necessary order parameters. It allows users to create, update & within the Pre-Ordering Management APIs. A Service Test is a procedure intended to check the quality, performance, or
retrieve Service Orders and manages related notifications. reliability of a Service.

TMF642 ALARM MANAGEMENT TMF634 RESOURCE CATALOG MANAGEMENT TMF664 RESOURCE FUNCTION ACTIVATION MANAGEMENT TMF639 RESOURCE INVENTORY MANAGEMENT TMF652 RESOURCE ORDER MANAGEMENT TMF687 STOCK MANAGEMENT TMF702 RESOURCE ACTIVATION MANAGEMENT*
Alarm Management builds on ITU recommendations, TM Resource Catalog manages the lifecycle of Resource Resource Function is used to represent a Network Service as well as a Resource Inventory manages allocated Resources (logical and physical) Resource Order Management allows for creating, updating and retrieving Stock Management provides for the creation, update and retrieval of the The Resource Activation and Configuration API can be used to query
RESOURCE

Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment Catalog elements and the consultation of resource Network Function. The Network Service and Network Function class that are typically used in support of Services. Resource Orders (including filtering). representation of a Product Stock, as well as the reservation, checking, resource instances to acquire the resource activation states and attributes,
between 3GPP and TM Forum, and the more recent ETSI catalog elements during several processes such as definitions and associations in TR244 (which, in turn, builds on concepts querying and adjusting of Product Stock. It also allows the for notification and it can be used to create/update, configure and activate the resource
work on requirements for NFV interfaces. ordering process. from the SID addenda on Logical Resource and Service) are utilized to of related events. instances.
define the Resource Function.

TMF666 ACCOUNT MANAGEMENT TMF720 DIGITAL IDENTITY MANAGEMENT TMF668 PARTNERSHIP TYPE MANAGEMENT TMF683 PARTY INTERACTION MANAGEMENT TMF632 PARTY MANAGEMENT TMF644 PRIVACY MANAGEMENT TMF700 SHIPPING ORDER MANAGEMENT*
BUSINESS PARTNER

Account Management of billing and settlement accounts, The digital identity allows identification of an This API manages partnership types in an onboarding process. It identifies a A User Interaction captures information about past interactions in order This API manages a Party, which can be an Individual or an Organization Privacy Management provides for privacy profile types, privacy profiles Provides the necessary functionality to create, update and query Shipping
and financial accounting (accounts receivable) in B2B or Individual, a Resource, or a Party Role (a specific type of partnership between parties, including the list of role types that are to re-use them in future ones. This allows agents to serve users better that has any kind of relationship with the enterprise. and privacy agreements such as creation, update, retrieval, deletion and Orders. A Shipping Order is a document used by a business to specify what
B2B2C contexts. role - or set of roles - for a given individual). A digital permitted (i.e. Buyer, Seller, Developer). Role types may refer to agreement by knowing the steps they went through. It also allows customers to see notification of events. items are to be transferred from a storage location or warehouse to which
identity is associated with credential / authentication specifications to be signed by parties playing the role. better the actions they have performed and how they interacted with us. person and to which new location. A ShippingOrder typically is sent along
method, which are extensible to describe all types with a shipment of goods so that the person receiving them can verify that
of authentication methods such as login/password, the document correctly reflects the items that they actually received.
TMF651 AGREEMENT MANAGEMENT TMF669 PARTY ROLE MANAGEMENT
biometric, token, etc. A contact medium is associated
The Agreement API manages agreements, especially in the This API manages general Party Roles (a Party acting in the role of...).
with a digital identity (or directly at credential level) to
context of partnerships between partners. Notice that Customer Party Role has a specific API.
manage credential recovery UCs.

TMF915 AI MANAGEMENT TMF662 ENTITY CATALOG MANAGEMENT TMF673 GEOGRAPHIC ADDRESS MANAGEMENT TMF706 TEST DATA MANAGEMENT TMF709 TEST SCENARIO MANAGEMENT
The AI Management Component Suite allows a Service Entity Catalog provides any SID entity to consumers Defines an Address management system, allowing validation and lookup of This API manages test data artefacts used for test case parameterization. This API manages Test Scenarios: The full specification of required test
Provider to govern Artificial Intelligence systems deployed at via a catalog, with its specification and policy worldwide addresses by: searching an area as a start (city, town ...), then the These include Test Data Schemas and Test Data Instances. elements, e.g. Test Case T parameterized with test data instance D running
scale. The initial focus is restricted to the in-life management providing governance over its content. The API streets of this area, and finally listing all the street segments (numbers) in a on abstract test environment E provisioned with a set of provisioning
of ‘model contracts’. provides management of the entity specifications and street. artefacts P.
their associations through CRUD operations.
COMMON BUSINESS ENTITIES

TMF655 CHANGE MANAGEMENT TMF688 EVENT MANAGEMENT* TMF674 GEOGRAPHIC SITE MANAGEMENT TMF705 TEST ENVIRONMENT MANAGEMENT TMF621 TROUBLE TICKET MANAGEMENT
Change Management defines interactions between external The Event Management API provides a standardized This API manages sites that can be associated with a customer, account, The management of test artefacts related to test environment Trouble Ticket Management provides for creating, tracking and managing
applications and a Change Management Application, based client interface to the enterprise event management service delivery or other entities. This allows reference to places important to specification, including Abstract Test Environments, Concrete Environment Trouble Tickets among partners as a result of an issue or Problem
on a Change Request. system for creating, managing and receiving service other entities. Metamodels (used to map abstract environments to concrete test identified by a Customer or another system, such as CRM applications,
related events to (indicatively) drive automation resources), Environment Provisioning Artefacts, and Test Resource APIs network management or fault management systems, or other trouble
workflows, notify other service providers for service exposed to test cases. ticket management systems (e.g. B2B).
outages and SLA violations, trigger Trouble Ticket
creation, and enable more complex orchestration
scenarios between management systems. The Event
TMF681 COMMUNICATION MANAGEMENT Management API can also be used to convey business TMF701 PROCESS FLOW MANAGEMENT* TMF708 TEST EXECUTION MANAGEMENT TMF672 USER ROLE PERMISSION MANAGEMENT
Provides a capability to create and send communications, The Process Flow API allows management (configuration/activation) of This API manages the test case, test suite, and non-functional test A User Role is the entity that defines a set of Privileges covering various
level Events in support of other processes.
notifications, and instructions to Parties, Individuals, business Processes made up of Tasks. It can coordinate these tasks which model execution. This also includes allocation and provisioning of test functions and/or manageable assets. When a User is assigned a given Role then
Organizations or Users. may require manual actions. environments for test execution. it is allocated all the Privileges defined for that Role type and the corresponding
Permissions are created for that user.

TMF667 DOCUMENT MANAGEMENT TMF710 GENERAL TEST ARTIFACT MANAGEMENT TMF704 TEST CASE MANAGEMENT TMF707 TEST RESULT MANAGEMENT
Document is used to manage the characteristics of a Management of Test artefacts that do not fall into the This API manages the test artefacts that do not fall into the categories Management of test results. These include Test Case Results, Test Suite
Document against its Specification (eg: book, picture, video). categories managed by TMF704, TMF705, TMF706, managed by TMF704, TMF705, TMF706, TMF707, or TMF709, such as Results, and Non-functional Test Results.
The document media is in the associated Attachment. TMF707, or TMF709, such as binaries, jars, etc. binaries, jars, etc.

The Open API map is a work in progress. If you wish to contribute or comment on the map, join us on the Open API team calls. Poster design © NetCracker® and TM Forum 2023. File updated: January 18, 2023