Tech-invite  3GPPspecsRELsGlossariesSIP
Info21222324252627282931323334353637384‑5x

full Contents for  TS 23.222  Word version:   17.0.0

Top   Up   Prev   Next
0…   4…   5   6…   6.3…   7…   8…   8.5…   8.9…   8.13…   8.17…   8.21…   8.25…   9…   10…   11…   A   B…   B.2   B.3   C…   D…

 

6  Functional modelWord-p. 20
6.1  General
The functional model for the common API framework (CAPIF) is organized into functional entities to describe a functional architecture which enables an API invoker to access and invoke service APIs. The CAPIF functional model can be adopted by any 3GPP functionality providing service APIs.
6.2  Functional model description
6.2.0  Functional model description for the CAPIF [R16]
Figure 6.2.0-1 shows the reference point based functional model for the CAPIF.
Up
The CAPIF is hosted within the PLMN operator network. The API invoker is typically provided by a 3rd party application provider who has service agreement with PLMN operator. The API invoker may reside within the same trust domain as the PLMN operator network.
In a reference point based model, the API invoker within the PLMN trust domain interacts with the CAPIF via CAPIF‑1 and CAPIF‑2. The API invoker from outside the PLMN trust domain interacts with the CAPIF via CAPIF‑1e and CAPIF‑2e. The API exposing function, the API publishing function and the API management function of the API provider domain (together known as API provider domain functions) within the PLMN trust domain interacts with the CAPIF core function via CAPIF‑3, CAPIF‑4 and CAPIF‑5 respectively.
Up
As illustrated in figure 6.2.0-2, the interactions between the API exposing functions within the PLMN trust domain is via CAPIF‑7.
The CAPIF core function provides CAPIF APIs to the API invoker over CAPIF‑1 and CAPIF‑1e. The API exposing function provides the service APIs to the API invoker over CAPIF‑2 and CAPIF‑2e.
NOTE 1:
The communication between the API exposing function and the CAPIF core function, between the API publishing function and the CAPIF core function and between the API management function and the CAPIF core function over CAPIF‑3, CAPIF‑4 and CAPIF‑5 respectively can be API based.
The detailed information of the APIs provided by the CAPIF core function is specified in clause 10.
The security aspects of CAPIF reference points are specified in 3GPP TS 33.122.
Figure 6.2.0-3 illustrates the CAPIF functional model using service-based interfaces.
Up
Table 6.2.0-1 specifies the service-based interfaces supported by CAPIF.
Service-based interface
Entity
APIs offered

Cccf
CAPIF core function
Specified in subclause 10
Caef
API exposing function
Specified in subclause 11

6.2.1  Functional model description to support 3rd party API providers [R16]Word-p. 23
Figure 6.2.1-1 shows the functional model for the CAPIF to support 3rd party API providers.
Up
The CAPIF core function in the PLMN trust domain supports service APIs from both the PLMN trust domain and the 3rd party trust domain having business relationship with PLMN. The API invokers may exist within the PLMN trust domain, or within the 3rd party trust domain or outside of both the PLMN trust domain and the 3rd party trust domain. The API provider domain 1 offers the service APIs from the PLMN operator. The API provider domain 2 offers the service APIs from the 3rd party. When the 3rd party API provider is a trusted 3rd party of the PLMN, the API provider domain 1 also offers the service APIs from the 3rd party.
The API invoker 2 within the PLMN trust domain interacts with the CAPIF core function via CAPIF‑1, and invokes the service APIs in the PLMN trust domain via CAPIF‑2 and invokes the service APIs in the 3rd party trust domain via CAPIF‑2e. The API invoker 3 within the 3rd party trust domain interacts with the CAPIF core function via CAPIF‑1e, and invokes the service APIs in the PLMN trust domain via CAPIF‑2e and invokes the service APIs in 3rd party trust domain via CAPIF‑2. The API invoker 1 from outside the PLMN trust domain and 3rd party trust domain, interacts with the CAPIF core function via CAPIF‑1e and invokes the service APIs in the PLMN trust domain and the service APIs in the 3rd party trust domain via CAPIF‑2e.
The API exposing function, the API publishing function and the API management function of the API provider domain 1 within the PLMN trust domain interacts with the CAPIF core function via CAPIF‑3, CAPIF‑4 and CAPIF‑5 respectively. The API exposing function, the API publishing function and the API management function of the API provider domain 2 within the 3rd party trust domain interacts with the CAPIF core function in the PLMN trust domain via CAPIF‑3e, CAPIF‑4e and CAPIF‑5e respectively. The API exposing function within the PLMN trust domain and the 3rd party trust domain provides the service APIs to the API invoker, offered by the respective trust domains.
The interactions between the API exposing functions within the PLMN trust domain is via CAPIF‑7 (not shown in the figure 6.2.1-1 for simplicity). The API exposing function within the PLMN trust domain interacts with the API exposing function in the 3rd party trust domain via CAPIF‑7e.
NOTE 1:
The communication between the API exposing function and the CAPIF core function, between the API publishing function and the CAPIF core function and between the API management function and the CAPIF core function over CAPIF‑3/3e, CAPIF‑4/4e and CAPIF‑5/5e respectively can be API based.
The detailed information of the APIs provided by the CAPIF core function is specified in clause 10.
NOTE 2:
The security aspects of CAPIF reference points are under SA3 responsibility and out of scope of the present document.
Up
6.2.2  Functional model description to support CAPIF interconnection [R16]Word-p. 24
Figure 6.2.2-1 shows the architectural model for the CAPIF interconnection which allows API invokers of a CAPIF provider to utilize the service APIs from the 3rd party CAPIF provider.
Up
Figure 6.2.2-2 shows the architectural model for the CAPIF interconnection within the same CAPIF provider domain, which allows API invokers of CAPIF core function 1 to utilize the service APIs from CAPIF core function 2, where both CAPIF core function 1 and CAPIF core function 2 are hosted within the trust domain of the CAPIF provider A.
Up
The CAPIF provider A and CAPIF provider B host the CAPIF in their trust domains. A business relationship exists between the CAPIF providers.
The CAPIF providers in their respective trust domain hosts multiple CAPIF instances where each CAPIF instance consists of the CAPIF core function (local), the API provider domain and the API invokers. All interactions within the CAPIF instance is according to the functional model specified in subclause 6.2.0.
When multiple CAPIF instances are deployed by a CAPIF provider there may be a hierarchy associated with the multiple CAPIF core function deployed which allows:
  • the designated CAPIF core function of the CAPIF provider A to interconnect with the designated CAPIF core function of the CAPIF provider B; and
  • within CAPIF provider A, one or more CAPIF core function interacts with the designated CAPIF core function 1.
The designated CAPIF core function of the CAPIF provider A provides the information about the CAPIF instances and service APIs deployed by the CAPIF provider A to the designated CAPIF core function of the CAPIF provider B and vice versa over CAPIF‑6e reference point.
The CAPIF core function 2 of CAPIF provider A provides the information about the service APIs to the CAPIF core function 1 over CAPIF‑6 reference point.
NOTE 1:
Void
The API invokers may exist within the trust domain of CAPIF provider A, or within the trust domain of CAPIF provider B or outside of the trust domains of both CAPIF provider A and CAPIF provider B. The API invoker of a CAPIF provider is onboarded with the CAPIF core function in the corresponding trust domain of the CAPIF provider.
NOTE 2:
For sake of simplicity, the service API interactions of API invokers of the CAPIF provider B are not shown. From each CAPIF provider's perspective the other CAPIF provider is a 3rd party.
One or more CAPIF core function can publish service APIs to the designated CAPIF core function over CAPIF‑6 reference point and, also discover the service APIs from the designated CAPIF core function and vice versa over CAPIF‑6 reference point.
The API invoker within the trust domain of CAPIF provider A interacts with the CAPIF core function of the CAPIF provider A via CAPIF‑1 and discovers the service APIs of both CAPIF providers, and invokes the service APIs in the trust domain of CAPIF provider A via CAPIF‑2 and invokes the service APIs in the trust domain of CAPIF provider B via CAPIF‑2e. The API invoker from outside the trust domain of CAPIF providers, interacts with the CAPIF core function of th CAPIF provider A via CAPIF‑1e and invokes the service APIs in the trust domain of the CAPIF providers via CAPIF‑2e.
NOTE 3:
The communication between the CAPIF core function of the CAPIF providers over CAPIF‑6 or CAPIF‑6e can be API based.
The detailed information of the APIs provided by the CAPIF core function is specified in clause 10.
NOTE 4:
The security aspects of CAPIF reference points are under SA3 responsibility and out of scope of the present document.
Up

Up   Top   ToC