C.3 CAPIF role in offline charging
23.2223GPPCommon API Framework for 3GPP Northbound APIsRelease 18TS
The API invocations are subjected to offline charging as illustrated in figure C.1-1.
The API exposing function provides the API invocation charging information to the CAPIF core function. The CAPIF core function provides the charging information to the offline charging system. The offline charging system generates the CDRs for the API invocation and further transfers the CDR files to the billing domain.
NOTE: The offline charging architecture for CAPIF including specification of offline charging system entities and reference points is under the responsibility of SA5.
Annex D (informative):
CAPIF relationship with external API frameworks
This annex provides the relationship of CAPIF with the OMA Network APIs and the ETSI MEC API framework. The relationship of CAPIF with these external API frameworks is illustrated in the table D-1. "Yes" means that the external API framework supports the CAPIF functionality, "No" means that the API framework does not support the CAPIF functionality, and "Partial" means that it provides a mechanism that partially supports the CAPIF functionality.
Table D-1: CAPIF relationship with external API frameworks
|
CAPIF functionalities |
OMA Network APIs |
ETSI MEC API framework |
||
|
Supported |
Reference |
Supported |
Reference |
|
|
Publish and discover service API information |
Partial (see NOTE) |
OMA-TS-NGSI_Registration_and_Discovery [11] |
Yes |
ETSI GS MEC 011 [7] |
|
Topology hiding of the service |
Yes |
Individual API exposing function |
Yes |
Individual API exposing function |
|
API invoker authentication to access service APIs |
Partial |
OMA-ER_Autho4API [9] |
Partial |
ETSI GS MEC 009 [8] |
|
API invoker authorization to access service APIs |
Partial |
OMA-ER_Autho4API [9] |
Partial |
ETSI GS MEC 009 [8] |
|
Charging on invocation of service APIs |
No |
No |
||
|
Lifecycle management of service APIs |
No |
No |
||
|
Monitoring service API invocations |
No |
No |
||
|
Logging API invoker onboarding and service API invocations |
No |
No |
||
|
Auditing service API invocations |
No |
No |
||
|
Onboarding API invoker to CAPIF |
No |
No |
||
|
CAPIF authentication of API invokers |
No |
No |
||
|
Service API access control |
Partial |
OMA-ER_Autho4API [9] |
Partial |
ETSI GS MEC 009 [8] |
|
Secure API communication |
Yes |
OMA-ER_Autho4API [9] |
Yes |
ETSI GS MEC 009 [8] |
|
Policy configuration |
No |
No |
||
|
API protocol stack model |
Partial |
for REST: OMA-TS_REST_NetAPI_Common [10] |
Partial |
for REST: |
|
API security protocol |
Partial |
OMA-ER_Autho4API [9] |
Partial |
ETSI GS MEC 009 [8] |
|
CAPIF support for service APIs from multiple providers |
No |
No |
||
|
NOTE: OMA-TS-NGSI_Registration_and_Discovery [11] is only applicable to a specific type of web services (OWSER using UDDI and WSDL). |
||||
Annex E (normative):
Configuration data for CAPIF
The configuration data is stored in the CAPIF core function and provided by the CAPIF administrator.
The configuration data for CAPIF is specified in table E-1.
Table E-1: Configuration data for CAPIF
|
Reference |
Parameter description |
|
Subclause 4.2.2 |
List of published service API discovery restrictions |
|
> Service API identification |
|
|
> API invoker identity information |
|
|
Subclause 4.7.2 |
List of service API log storage durations |
|
> Service API identification |
|
|
> Service API log storage duration (in hours) (see NOTE) |
|
|
Subclause 4.7.4 |
List of API invoker interactions log storage durations |
|
> Service API identification |
|
|
API invoker interactions log storage duration (in hours) (see NOTE) |
|
|
Subclause 4.10 |
List of access control policy per API invoker |
|
> Volume limit on service API invocations (total number of invocations allowed) |
|
|
> Time limit on service API invocations (The time range of the day during which the service API invocations are allowed) |
|
|
> Rate limit on service API invocations (allowed service API invocations per second) |
|
|
> Service API identification |
|
|
> API invoker identity information |
|
|
NOTE: If no value is set for the duration, the duration is assumed to be unlimited. |
|
Annex F (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2017-10 |
SA6#19 |
S6-171274 |
TS skeleton |
0.0.0 |
|||
|
2017-10 |
SA6#19 |
Implementation of the following p-CRs approved by SA6: S6-171444; S6-171343; S6-171445; S6-171446; S6-171466; S6-171448; S6-171348; S6-171449; S6-171359; S6-171467; S6-171451; S6-171452; S6-171362; S6-171463; S6-171356; S6-171355; S6-171453; S6-171454; S6-171455; S6-171464; S6-171468; S6-171350; S6-171349; S6-171407. |
0.1.0 |
||||
|
2017-12 |
SA6#20 |
Implementation of the following p-CRs approved by SA6: S6-171630; S6-171631; S6-171633; S6-171648; S6-171650; S6-171658; S6-171659; S6-171692; S6-171693; S6-171694; S6-171695; S6-171698; S6-171699; S6-171700; S6-171702; S6-171704; S6-171705; S6-171706; S6-171711; S6-171712; S6-171713; S6-171819; S6-171820; S6-171821; S6-171822; S6-171823; S6-171848; S6-171855; S6-171865; S6-171876. |
0.2.0 |
||||
|
2017-12 |
SA#78 |
SP-170901 |
Submitted to SA#78 for approval |
1.0.0 |
|||
|
2018-01 |
SA#78 |
SP-170901 |
MCC Editorial update for publication after TSG SA approval (SA#78) |
15.0.0 |
|||
|
2018-04 |
SA#79 |
SP-180156 |
0001 |
1 |
F |
Use of specific ETSI and OMA references |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0002 |
F |
Corrections for CAPIF-1e and CAPIF-2e |
15.1.0 |
|
|
2018-04 |
SA#79 |
SP-180156 |
0003 |
F |
Miscellaneous corrections to procedures and information flows |
15.1.0 |
|
|
2018-04 |
SA#79 |
SP-180156 |
0004 |
1 |
F |
Addition of offboarding to functional entities and reference points description |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0005 |
1 |
D |
Editorial corrections |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0006 |
2 |
B |
Solution to EN on revoking authorization based on access control |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0007 |
3 |
F |
Configuration items for CAPIF |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0008 |
3 |
F |
Update to CAPIF relationship with 3GPP EPS and 5GS |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0009 |
1 |
F |
Solution to EN on policy synchronization |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0010 |
2 |
F |
CAPIF utilization by service APIs |
15.1.0 |
|
2018-04 |
SA#79 |
SP-180156 |
0011 |
1 |
F |
Proposal for definition for PLMN trust domain |
15.1.0 |
|
2018-06 |
SA#80 |
SP-180374 |
0013 |
1 |
F |
Correction for the details of service API information |
15.2.0 |
|
2018-06 |
SA#80 |
SP-180374 |
0014 |
1 |
F |
Correction for usage of service API identification information |
15.2.0 |
|
2018-06 |
SA#80 |
SP-180374 |
0019 |
2 |
D |
Editorial correction of TS 23.222 (CAPIF stage2) |
15.2.0 |
|
2018-06 |
SA#80 |
SP-180375 |
0012 |
2 |
B |
Architecture functional model to support multiple API providers |
16.0.0 |
|
2018-06 |
SA#80 |
SP-180375 |
0015 |
1 |
B |
Service API publish and discovery requirements for 3rd party API providers |
16.0.0 |
|
2018-06 |
SA#80 |
SP-180375 |
0016 |
1 |
B |
Charging requirements for 3rd party API providers |
16.0.0 |
|
2018-06 |
SA#80 |
SP-180375 |
0017 |
1 |
B |
OAM requirements for 3rd party API providers |
16.0.0 |
|
2018-06 |
SA#80 |
SP-180375 |
0018 |
2 |
B |
CAPIF interconnection requirements |
16.0.0 |
|
2018-06 |
SA#80 |
SP-180375 |
0020 |
2 |
F |
Updating representation of deployment models |
16.0.0 |
|
2018-09 |
SA#81 |
SP-180675 |
0021 |
2 |
B |
Integrated CAPIF with 3GPP EPS and 5GS network exposure |
16.1.0 |
|
2018-09 |
SA#81 |
SP-180675 |
0022 |
1 |
C |
Enhancement to the functional model deployments |
16.1.0 |
|
2018-09 |
SA#81 |
SP-180675 |
0023 |
2 |
B |
Enhancement to reference points for eCAPIF |
16.1.0 |
|
2018-09 |
SA#81 |
SP-180674 |
0029 |
1 |
A |
Update API naming convention |
16.1.0 |
|
2018-09 |
SA#81 |
SP-180674 |
0030 |
2 |
A |
Alignment of APIs |
16.1.0 |
|
2018-09 |
SA#81 |
SP-180674 |
0031 |
1 |
A |
Alignment to SA3 CAPIF TS |
16.1.0 |
|
2018-09 |
SA#81 |
SP-180674 |
0032 |
1 |
Alignment to SA3 authentication procedure |
16.1.0 |
|
|
2018-09 |
SA#81 |
SP-180675 |
0033 |
3 |
B |
Functional architecture for CAPIF interconnection |
16.1.0 |
|
2018-12 |
SA#82 |
SP-181176 |
0034 |
3 |
B |
Topology hiding enhancement |
16.2.0 |
|
2018-12 |
SA#82 |
SP-181176 |
0035 |
2 |
B |
API publish and API discover for CAPIF interconnection |
16.2.0 |
|
2018-12 |
SA#82 |
SP-181176 |
0036 |
1 |
C |
Architectural requirements for identities |
16.2.0 |
|
2018-12 |
SA#82 |
SP-181176 |
0038 |
2 |
B |
Architectural requirements for provider domain entities interaction |
16.2.0 |
|
2018-12 |
SA#82 |
SP-181176 |
0039 |
2 |
B |
Update API invoker API list |
16.2.0 |
|
2018-12 |
SA#82 |
SP-181175 |
0043 |
2 |
A |
API invoker’s onboarding response rel16 |
16.2.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0044 |
2 |
F |
Update procedures with topology hidding |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0045 |
2 |
B |
API sharing for CCF interconnection |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0046 |
2 |
B |
API invocation request routing with topology hiding |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0048 |
1 |
C |
Interactions between API exposing functions |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0049 |
1 |
B |
Service API discovery involving multiple CCFs |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0050 |
2 |
B |
Multiple CCFs deployment in a PLMN trust domain |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0051 |
2 |
B |
Service API discover for CAPIF interconnection |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0052 |
1 |
B |
Architectural requirements for registration of API provider domain functions |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0053 |
2 |
B |
Procedures for registration of API provider domain functions |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0054 |
1 |
B |
Updates to AEF procedures for 3rd party trust domain |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0055 |
1 |
B |
Updates to APF procedures for 3rd party trust domain |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0056 |
1 |
B |
Updates to AMF procedures for 3rd party trust domain |
16.3.0 |
|
2019-03 |
SA#83 |
SP-190072 |
0057 |
– |
B |
Updates to CAPIF events procedures for 3rd party trust domain |
16.3.0 |
|
2019-06 |
SA#84 |
SP-190483 |
0058 |
1 |
F |
Clarification to routing rule of service API invocation |
16.4.0 |
|
2019-06 |
SA#84 |
SP-190483 |
0059 |
3 |
F |
Functional model update with reference points |
16.4.0 |
|
2019-06 |
SA#84 |
SP-190483 |
0060 |
2 |
B |
Update to service API publish for CAPIF interconnection |
16.4.0 |
|
2019-06 |
SA#84 |
SP-190483 |
0061 |
2 |
B |
Serving area and domain of service API for CAPIF interconnection |
16.4.0 |
|
2019-06 |
SA#84 |
SP-190483 |
0062 |
1 |
B |
3rd party trust domain with network exposure and charging aspects of 3GPP systems |
16.4.0 |
|
2019-06 |
SA#84 |
SP-190483 |
0063 |
1 |
B |
Interface based representation of CAPIF architecture |
16.4.0 |
|
2019-09 |
SA#85 |
SP-190828 |
0064 |
1 |
F |
Clarification and alignment with publish request information flows |
16.5.0 |
|
2019-12 |
SA#86 |
SP-191107 |
0065 |
F |
Correction on usage of service API information in access control message |
16.6.0 |
|
|
2020-03 |
SA#87-E |
SP-200112 |
0066 |
1 |
F |
Shared CAPIF provider domain info in interconnection |
16.7.0 |
|
2020-03 |
SA#87-E |
SP-200116 |
0067 |
2 |
B |
Serving area information for service APIs to support edge applications |
17.0.0 |
|
2020-07 |
SA#88-E |
SP-200337 |
0069 |
A |
Add consumer for discover and publish service APIs |
17.1.0 |
|
|
2020-07 |
SA#88-E |
SP-200337 |
0071 |
A |
Add obtaining routing info service API |
17.1.0 |
|
|
2020-07 |
SA#88-E |
SP-200337 |
0073 |
1 |
A |
Correct API topology hiding |
17.1.0 |
|
2020-07 |
SA#88-E |
SP-200337 |
0075 |
1 |
A |
Correction for CAPIF interconnection IEs |
17.1.0 |
|
2020-09 |
SA#89-E |
SP-200840 |
0077 |
3 |
F |
Correction for API routing information |
17.2.0 |
|
2020-12 |
SA#90-E |
SP-200997 |
0078 |
2 |
B |
Support AEF location and API invoker interface for edge application |
17.3.0 |
|
2021-04 |
SA#91-E |
SP-210183 |
0079 |
4 |
F |
Clarification of Service-based interfaces interaction within CAPIF |
17.4.0 |
|
2021-06 |
SA#92-E |
SP-210482 |
0082 |
A |
API provider management API |
17.5.0 |
|
|
2022-06 |
SA#96 |
SP-220471 |
0084 |
1 |
A |
Corrections to API invoker onboarding/offboarding in TS 23.222 |
17.6.0 |
|
2022-09 |
SA#97 |
SP-220918 |
0089 |
A |
Corrections to API invoker onboarding/offboarding in TS 23.222 |
17.7.0 |
|
|
2022-12 |
SA#98-e |
SP-221250 |
0090 |
1 |
B |
Additional CAPIF architectural requirements for SNA |
18.0.0 |
|
2022-12 |
SA#98-e |
SP-221250 |
0091 |
2 |
B |
CAPIF business relationship updates for SNA |
18.0.0 |
|
2022-12 |
SA#98-e |
SP-221250 |
0092 |
2 |
B |
CAPIF functional model updates for SNA |
18.0.0 |
|
2022-12 |
SA#98-e |
SP-221250 |
0093 |
2 |
B |
API invoker obtaining authorization from resource owner |
18.0.0 |
|
2022-12 |
SA#98-e |
SP-221250 |
0094 |
1 |
B |
Discover a proper AEF with owner information |
18.0.0 |
|
2022-12 |
SA#98-e |
SP-221250 |
0095 |
2 |
B |
Reducing resource owner consent inquiry in a nested API invocation |
18.0.0 |
|
2022-12 |
SA#98-e |
SP-221239 |
0096 |
2 |
B |
CAPIF extensibility as requested by ETSI ISG MEC |
18.0.0 |