Menu
Latest
12 meetings · Prague, Jeju · 12–16 Oct
Reports
RAN1#126-bis · SA2#177

Glossary term · Services

API invoker

API invoker

Services →

API invoker is the entity that invokes CAPIF or service APIs in 3GPP networks, representing applications or network functions that consume exposed services to enable programmatic access to 5G capabilities.

Introduced
Rel-15
Where
Services › IMS
Specifications
2 specs
API invoker Description Purpose What changed Neighbours Detected Changes Specifications

Description

The API invoker is a fundamental concept in the 3GPP Common API Framework (CAPIF) and service-based architecture. Defined in TS 23.222 and TS 23.722, an API invoker is the entity that invokes CAPIF or service APIs. This entity can be an application function (AF), a network function (NF), or an external application that consumes services exposed by an API exposing function (AEF). The API invoker is the consumer side of the API interaction, while the AEF is the provider side. The CAPIF framework standardises how APIs are discovered, invoked, and secured, and the API invoker is the actor that initiates these operations.

In the CAPIF architecture, the API invoker interacts with the CAPIF Core Function (CCF) to discover service APIs, obtain authorization, and authenticate. The API invoker must register with the CCF, providing its identity and credentials. Once registered, it can query the CCF for available service APIs and receive information about the AEFs that provide them. The API invoker then invokes the service API directly with the AEF, using the access token obtained from the CCF. This separation of concerns allows the CCF to manage authentication and authorization centrally, while the AEF focuses on service logic.

The API invoker concept is also used in the context of the Service Based Architecture (SBA) for 5G core networks, where network functions (NFs) act as API invokers when they consume services from other NFs. For example, an SMF may invoke the NRF's discovery service, or an AMF may invoke the UDM's subscriber data service. In SBA, the API invoker is typically an NF that uses HTTP/2-based APIs. The API invoker role is defined in TS 23.501 and related specifications, and it is essential for the modular, service-oriented design of the 5G core.

The API invoker can be internal or external to the 3GPP network. Internal API invokers are NFs within the core network, while external API invokers are applications outside the network, such as third-party service providers. For external invokers, the NEF acts as the AEF, exposing network capabilities securely. The API invoker must adhere to the API specifications, including data models and protocols, to ensure interoperability.

In summary, the API invoker is the consumer of 3GPP APIs, playing a critical role in enabling programmatic access to network services. It is the counterpart to the AEF and is central to the CAPIF and SBA frameworks. The API invoker concept facilitates the exposure of 5G capabilities to a wide range of applications, driving innovation and service differentiation.

Purpose & Motivation

The API invoker concept was created to standardise the consumer side of API interactions in 3GPP networks. Before CAPIF, API exposure was fragmented, with different vendors and specifications using proprietary mechanisms. This made it difficult for applications to discover and invoke services consistently. The API invoker provides a common role that can be used across all 3GPP APIs, ensuring that any application or NF can act as a consumer with a uniform procedure. It solves the problem of interoperability by defining how an entity registers, discovers, and invokes APIs. The concept also supports security by requiring API invokers to authenticate and obtain authorization from the CCF. In the context of SBA, the API invoker is essential for the service-oriented architecture of the 5G core, where NFs communicate via APIs. The API invoker role enables the modularity and flexibility that are hallmarks of 5G, allowing new services to be added without disrupting existing ones.

What changed in its specifications

The latest release-to-release comparison of specifications that define API invoker. Each summary describes the whole specification, not only this term.

TS 23.222Rel-18 → Rel-19

Rel-19 adds CAPIF Phase 3 procedures for unpublishing service APIs between interconnected core functions, revoking API invoker and resource owner authorization, open discovery of service APIs, and UE-hosted API invoker access to resources owned by other UEs.

Full comparison in TS 23.222 →

Release Timeline

Detected Changes Across Releases

from 3GPP Change Requests

Specific changes extracted from the „Change history“ tables of 3GPP specifications (29 CRs across 5 releases). Complements the general historical overview above with the evidence-based evolution of this function.

Studied in Rel-15, normative work from Rel-16.

Rel-16 2 changes
  • Update API invoker API list TS 23.222CR0039
  • API invoker's onboarding response rel16 TS 23.222CR0043
Rel-17 3 changes
  • Support AEF location and API invoker interface for edge application TS 23.222CR0078
  • Corrections to API invoker onboarding/offboarding in TS 23.222 TS 23.222CR0084
  • Corrections to API invoker onboarding/offboarding in TS 23.222 TS 23.222CR0089
Rel-18 4 changes
  • API invoker obtaining authorization from resource owner TS 23.222CR0093
  • API invoker clarification TS 23.222CR0100
  • API invoker authorization corrections TS 23.222CR0137
  • Corrections for CAPIF revocation of API Invoker's authorization based on RNAA TS 23.222CR0149
Rel-19 15 changes
  • Update to API invoker Roles in CAPIF TS 23.222CR0202
  • API invoker onboarding TS 23.222CR0214
  • API invoker split into frontend and backend components TS 23.222CR0221
  • Enhancement to API invoker Authorization with the Purpose of Data Processing TS 23.222CR0226
  • Enhancement to API invoker Authorization with the Purpose of Data Processing TS 23.222CR0227
  • UE-deployed API invoker accessing other UEs’ resources of a group TS 23.222CR0230

+ 9 more changes

Rel-20 5 changes
  • API invoker deployed in an application server accessing UEs’ resources of a group of UEs TS 23.222CR0342
  • API invoker error reporting TS 23.222CR0346
  • CCF control of API invoker reporting TS 23.222CR0355
  • API invoker error reporting TS 23.222CR0361
  • API invoker information for a Group of UEs TS 23.222CR0365

Defining Specifications

3GPP specifications that define or reference API invoker, with the latest known release. Sourced from the 3GPP document catalog — see methodology.

SpecificationTitleRelease
TS 23.222 vk10 Common API Framework (CAPIF) Rel-20 read
TS 23.722 vf10 Common API Framework (CAPIF) for 3GPP Northbound APIs Rel-15 read