Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TR 23.722
Word version: 15.1.0
0…
4…
4
Analysis of external API frameworks
5
Key issues
6
Architectural requirements
7
Solutions
8
Overall evaluation
9
Conclusions
A
API work done by other 3GPP WGs
B
OMA API Program
C
ETSI MEC API framework
$
Change History
4
Analysis of external API frameworks
p. 10
4.1
Introduction
p. 10
4.2
OMA API framework
p. 11
4.2.1
Description
p. 11
4.2.2
Detailed analysis
p. 11
5
Key issues
p. 12
5.1
Publish and discover service API information
p. 12
5.2
Topology hiding of the service
p. 12
5.3
API invoker authentication to access service APIs
p. 12
5.4
API invoker authorization to access service APIs
p. 13
5.5
Charging on invocation of service APIs
p. 13
5.6
Lifecycle management of service APIs
p. 13
5.7
Monitoring service API invocations
p. 13
5.8
Logging API invoker onboarding and service API invocations
p. 13
5.9
Auditing service API invocations
p. 13
5.10
Onboarding API invoker to CAPIF
p. 13
5.11
CAPIF authentication towards API invokers
p. 13
5.12
Service API access control
p. 14
5.13
Secure API communication
p. 14
5.14
Policy configuration
p. 14
5.15
API protocol stack model
p. 14
5.16
API security protocol
p. 14
5.17
CAPIF support for service APIs from multiple providers
p. 14
6
Architectural requirements
p. 15
6.1
General requirements
p. 15
6.2
Service API publish and discover requirements
p. 15
6.2.1
General
p. 15
6.2.2
Requirements
p. 15
6.3
Security requirements
p. 15
6.3.1
General
p. 15
6.3.2
Requirements
p. 15
6.4
Charging requirements
p. 16
6.4.1
General
p. 16
6.4.2
Requirements
p. 16
6.5
Lifecycle management requirements
p. 16
6.5.1
General
p. 16
6.5.2
Requirements
p. 16
6.6
Monitoring service API invocation requirements
p. 17
6.6.1
General
p. 17
6.6.2
Requirements
p. 17
6.7
Logging service API invocation requirements
p. 17
6.7.1
General
p. 17
6.7.2
Requirements
p. 17
6.8
Auditing service API invocation requirements
p. 17
6.8.1
General
p. 17
6.8.2
Requirements
p. 17
6.9
Onboarding API invoker requirements
p. 18
6.9.1
General
p. 18
6.9.2
Requirements
p. 18
6.10
Policy configuration requirements
p. 18
6.10.1
General
p. 18
6.10.2
Requirements
p. 18
6.11
Protocol design requirements
p. 18
6.11.1
General
p. 18
6.11.2
Requirements
p. 18
6.12
Logging API invoker onboarding requirements
p. 18
6.12.1
General
p. 18
6.12.2
Requirements
p. 19
6.13
CAPIF interaction logging requirements
p. 19
6.13.1
General
p. 19
6.13.2
Requirements
p. 19
7
Solutions
p. 19
7.1
High level architecture
p. 19
7.1.1
Solution 1 - High level functional architecture for the CAPIF
p. 19
7.1.1.1
Solution description
p. 19
7.1.1.1.1
General
p. 19
7.1.1.1.2
Architectural Model
p. 19
7.1.1.1.3
Reference points
p. 21
7.1.1.1.4
Deployment options
p. 22
7.1.1.1.4.1
General
p. 22
7.1.1.1.4.2
Option 1 - Centralized deployment
p. 22
7.1.1.1.4.3
Option 2 - Distributed deployment
p. 22
7.1.1.2
Solution evaluation
p. 25
7.1.2
Solution 2 - CAPIF architecture for service APIs from 3rd party service provider
p. 26
7.1.2.1
Solution description
p. 26
7.1.2.1.1
General
p. 26
7.1.2.1.2
Architectural Model
p. 26
7.1.2.1.3
Reference points
p. 27
7.1.2.1.4
Deployment options
p. 27
7.1.2.1.4.1
Option 1 - PLMN operator hosted service APIs and CAPIF core functions
p. 27
7.1.2.1.4.2
Option 2 - 3rd party service provider hosted service APIs and CAPIF core functions
p. 28
7.1.2.1.4.3
Option 3 - PLMN operator-assisted service capability APIs and CAPIF core functions for a 3rd party service provider
p. 28
7.1.2.2
Solution evaluation
p. 29
7.1.3
Solution 3 - High level functional architecture to support service APIs from 3rd party API providers via CAPIF interconnection
p. 30
7.1.3.1
Solution description
p. 30
7.1.3.1.1
General
p. 30
7.1.3.1.2
Architectural Model
p. 30
7.1.3.1.3
Reference points
p. 31
7.1.3.2
Solution evaluation
p. 31
7.2
Solutions to key issues
p. 32
7.2.1
Solution 1: Publish service APIs
p. 32
7.2.1.1
Solution description
p. 32
7.2.1.2
Solution evaluation
p. 32
7.2.2
Solution 2: Discover service APIs
p. 33
7.2.2.1
Solution description
p. 33
7.2.2.2
Solution evaluation
p. 33
7.2.3
Solution 3: Subscription and notifications for the CAPIF events related to service APIs
p. 34
7.2.3.1
Solution description
p. 34
7.2.3.1.1
General
p. 34
7.2.3.1.2
Procedure
p. 34
7.2.3.2
Solution evaluation
p. 35
7.2.4
Solution 4: CAPIF topology hiding
p. 35
7.2.4.1
Solution description
p. 35
7.2.4.1.1
General
p. 35
7.2.4.1.2
Procedure
p. 35
7.2.4.2
Solution evaluation
p. 36
7.2.5
Solution 5: Onboarding API invoker to the CAPIF
p. 36
7.2.5.1
Solution description
p. 36
7.2.5.1.1
General
p. 36
7.2.5.1.2
Procedure
p. 36
7.2.5.2
Solution evaluation
p. 37
7.2.6
Solution 6: Authentication between the API invoker and the CAPIF core functions
p. 38
7.2.6.1
Solution description
p. 38
7.2.6.1.1
General
p. 38
7.2.6.1.2
Procedure
p. 38
7.2.6.2
Solution evaluation
p. 38
7.2.7
Solution 7: Obtaining authorization to access service API
p. 39
7.2.7.1
Solution description
p. 39
7.2.7.1.1
General
p. 39
7.2.7.1.2
Procedure
p. 39
7.2.7.2
Solution evaluation
p. 39
7.2.8
Solution 8: Authentication between the API invoker and the AEF as separate procedure
p. 40
7.2.8.1
Solution description
p. 40
7.2.8.1.1
General
p. 40
7.2.8.1.2
Procedure
p. 40
7.2.8.2
Solution evaluation
p. 40
7.2.9
Solution 9: Secure communication
p. 41
7.2.9.1
Solution description
p. 41
7.2.9.2
Solution evaluation
p. 41
7.2.10
Solution 10: API invoker authorization to access service APIs
p. 41
7.2.10.1
Solution description
p. 41
7.2.10.1.1
General
p. 41
7.2.10.1.2
Procedure
p. 41
7.2.10.2
Solution evaluation
p. 42
7.2.11
Solution 11: Logging service API invocations
p. 42
7.2.11.1
Solution description
p. 42
7.2.11.1.1
General
p. 42
7.2.11.1.2
Procedure
p. 43
7.2.11.2
Solution evaluation
p. 43
7.2.12
Solution 12: Auditing service API invocation
p. 43
7.2.12.1
Solution description
p. 43
7.2.12.1.1
General
p. 43
7.2.12.1.2
Procedure
p. 44
7.2.12.2
Solution evaluation
p. 44
7.2.13
Solution 13: Charging the invocation of service APIs
p. 44
7.2.13.1
Solution description
p. 44
7.2.13.1.1
General
p. 44
7.2.13.1.2
Procedure
p. 44
7.2.13.2
Solution evaluation
p. 45
7.2.14
Solution 14: Monitoring service API invocation
p. 45
7.2.14.1
Solution description
p. 45
7.2.14.1.1
General
p. 45
7.2.14.1.2
Procedure
p. 45
7.2.14.2
Solution evaluation
p. 46
7.2.15
Solution 15: CAPIF access control
p. 46
7.2.15.1
Solution description
p. 46
7.2.15.1.1
General
p. 46
7.2.15.1.2
Procedure
p. 46
7.2.15.2
Solution evaluation
p. 47
7.2.16
Solution 16: CAPIF access control with cascaded AEFs
p. 47
7.2.16.1
Solution description
p. 47
7.2.16.1.1
General
p. 47
7.2.16.1.2
Procedure
p. 47
7.2.16.2
Solution evaluation
p. 48
7.2.17
Solution 17: Authentication between the API invoker and the AEF as part of the API invocation
p. 48
7.2.17.1
Solution description
p. 48
7.2.17.1.1
General
p. 48
7.2.17.1.2
Procedure
p. 49
7.2.17.2
Solution evaluation
p. 49
8
Overall evaluation
p. 49
8.1
General
p. 49
8.2
Architecture evaluation
p. 50
8.3
Solution evaluation
p. 50
9
Conclusions
p. 51
A
API work done by other 3GPP WGs
p. 53
A.1
General
p. 53
A.2
Discussion
p. 53
A.2.1
SA4: API for the interface between MBMS service provider and BM-SC (xMB)
p. 53
A.2.2
SA2, CT3: SCEF to expose the services and capabilities provided by 3GPP network interfaces and protocols
p. 54
A.2.3
CT3: Representational State Transfer (REST) protocol-based St reference point
p. 54
A.2.4
CT3: Representational State Transfer (REST) reference point between the Application Function (AF) and the Protocol Converter (PC)
p. 54
A.3
Summary
p. 55
B
OMA API Program
p. 57
B.1
General
p. 57
B.2
OMA API Architecture
p. 58
B.2.1
General
p. 58
B.2.2
OMA Next Generation Service Interfaces (NGSI) for Abstract APIs
p. 58
B.2.2.1
OMA reference architecture of Abstract APIs
p. 58
B.2.2.2
Service Registration and Discovery
p. 58
B.2.2.3
Identity Control
p. 58
B.2.2.4
Data Configuration and Management
p. 59
B.2.3
OMA RESTful APIs
p. 59
B.2.3.1
Authorization Framework for Network APIs
p. 59
B.2.3.2
RESTful Network API for Capability Discovery
p. 59
B.3
API consistency within OMA APIs
p. 59
C
ETSI MEC API framework
p. 61
C.1
General
p. 61
C.2
MEC Application Enablement
p. 62
C.3
Design aspects of ETSI MEC APIs
p. 63
C.3.1
General
p. 63
C.3.2
Entry point of a Mobile Edge service API
p. 63
C.3.3
API security and privacy considerations
p. 64
C.3.4
API template
p. 64
C.3.5
Patterns of the API
p. 64
$
Change History
p. 65