ETSI TS 123 222 V16.10.0 (2021-07)

LTE; 5G; Common API Framework for 3GPP Northbound APIs (3GPP TS 23.222 version 16.10.0 Release 16)

RTS/TSGS-0623222vga0

General Information

• Status: Not Published
• Technical Committee: 3GPP SA 6 - Mission-critical applications
• Current Stage: 12 - Completion
• Completion Date: 29-Jul-2021

Standards Content (Sample)

ETSI TS 123 222 V16.10.0 (2021-07)






TECHNICAL SPECIFICATION
LTE;
5G;
Common API Framework for 3GPP Northbound APIs
(3GPP TS 23.222 version 16.10.0 Release 16)

---------------------- Page: 1 ----------------------
3GPP TS 23.222 version 16.10.0 Release 16 1 ETSI TS 123 222 V16.10.0 (2021-07)

Reference
RTS/TSGS-0623222vga0
Keywords
5G,LTE
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871

Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.

Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and
microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© ETSI 2021.
All rights reserved.

ETSI

---------------------- Page: 2 ----------------------
3GPP TS 23.222 version 16.10.0 Release 16 2 ETSI TS 123 222 V16.10.0 (2021-07)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are publicly available for ETSI members and non-members, and can be
found in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to
ETSI in respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the
ETSI Web server (https://ipr.etsi.org/).
Pursuant to the ETSI Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not
referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become,
essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its

Members. 3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and of the 3GPP
Organizational Partners. oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and of the
®
oneM2M Partners. GSM and the GSM logo are trademarks registered and owned by the GSM Association.
Legal Notice
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities. These shall be
interpreted as being references to the corresponding ETSI deliverables.
The cross reference between 3GPP and ETSI identities can be found under http://webapp.etsi.org/key/queryform.asp.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI

---------------------- Page: 3 ----------------------
3GPP TS 23.222 version 16.10.0 Release 16 3 ETSI TS 123 222 V16.10.0 (2021-07)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 10
Introduction . 10
1 Scope . 11
2 References . 11
3 Definitions and abbreviations . 11
3.1 Definitions . 11
3.2 Abbreviations . 12
4 Architectural requirements . 13
4.1 General . 13
4.1.1 Introduction. 13
4.1.2 Requirements . 13
rd
4.1.3 Requirements for supporting 3 party API providers . 13
4.2 Service API publish and discover . 13
4.2.1 Introduction. 13
4.2.2 Requirements . 13
rd
4.2.3 Requirements for 3 party API providers . 14
4.3 Security . 14
4.3.1 Introduction. 14
4.3.2 Requirements . 14
rd
4.3.3 Additional requirements for 3 party API provider . 14
4.4 Charging . 14
4.4.1 Introduction. 14
4.4.2 Requirements . 15
rd
4.4.3 Requirements for 3 party API providers . 15
4.5 Operations, Administration and Maintenance . 15
4.5.1 Introduction. 15
4.5.2 Requirements . 15
rd
4.5.3 Requirements for 3 party API providers . 15
4.6 Service API invocation monitoring . 15
4.6.1 Introduction. 15
4.6.2 Requirements . 16
4.7 Logging . 16
4.7.1 Introduction. 16
4.7.2 Logging events related to service API invocations . 16
4.7.3 Logging events related to API invoker onboarding . 16
4.7.4 Logging events related to API invoker interaction with the CAPIF . 16
4.8 Auditing service API invocation . 17
4.8.1 Introduction. 17
4.8.2 Requirements . 17
4.9 Onboarding API invoker . 17
4.9.1 Introduction. 17
4.9.2 Requirements . 17
4.10 Policy configuration . 17
4.10.1 Introduction. 17
4.10.2 Requirements . 17
4.11 Protocol design . 17
4.11.1 Introduction. 17
4.11.2 Requirements . 17
4.12 Interconnection between the CAPIF providers. 18
4.12.1 Introduction. 18
ETSI

---------------------- Page: 4 ----------------------
3GPP TS 23.222 version 16.10.0 Release 16 4 ETSI TS 123 222 V16.10.0 (2021-07)
4.12.2 Requirements . 18
4.13 Identities . 18
4.13.1 Introduction. 18
4.13.2 Requirements . 18
4.14 API provider domain interactions . 18
4.14.1 Introduction. 18
4.14.2 Requirements . 18
4.15 Dynamic routing of service API invocation . 19
4.15.1 Introduction. 19
4.15.2 Requirements . 19
4.16 Registering API provider domain functions . 19
4.16.1 Introduction. 19
4.16.2 Requirements . 19
5 Involved business relationships . 19
6 Functional model . 20
6.1 General . 20
6.2 Functional model description . 20
6.2.0 Functional model description for the CAPIF . 20
rd
6.2.1 Functional model description to support 3 party API providers . 22
6.2.2 Functional model description to support CAPIF interconnection . 23
6.3 Functional entities description . 25
6.3.1 General . 25
6.3.2 API invoker . 25
6.3.3 CAPIF core function . 25
6.3.4 API exposing function . 26
6.3.5 API publishing function . 26
6.3.6 API management function . 26
6.4 Reference points . 26
6.4.1 General . 26
6.4.2 Reference point CAPIF-1 (between the API invoker and the CAPIF core function) . 26
6.4.3 Reference point CAPIF-1e (between the API invoker and the CAPIF core function). 27
6.4.4 Reference point CAPIF-2 (between the API invoker and the API exposing function) . 27
6.4.5 Reference point CAPIF-2e (between the API invoker and the API exposing function) . 27
6.4.6 Reference point CAPIF-3 (between the API exposing function and the CAPIF core function) . 27
6.4.7 Reference point CAPIF-4 (between the API publishing function and the CAPIF core function) . 28
6.4.8 Reference point CAPIF-5 (between the API management function and the CAPIF core function) . 28
6.4.9 Reference point CAPIF-3e (between the API exposing function and the CAPIF core function) . 28
6.4.10 Reference point CAPIF-4e (between the API publishing function and the CAPIF core function) . 29
6.4.11 Reference point CAPIF-5e (between the API management function and the CAPIF core function) . 29
6.4.12 Reference point CAPIF-7 (between the API exposing functions) . 29
6.4.13 Reference point CAPIF-7e (between the API exposing functions) . 29
6.4.14 Reference point CAPIF-6 (between the CAPIF core functions of the same CAPIF provider) . 29
6.4.15 Reference point CAPIF-6e (between the CAPIF core functions of different CAPIF providers) . 30
7 Application of functional model to deployments . 30
7.1 General . 30
7.2 Centralized deployment . 30
7.3 Distributed deployment . 31
7.4 Multiple CCFs deployment . 34
8 Procedures and information flows . 35
8.1 Onboarding the API invoker to the CAPIF . 35
8.1.1 General . 35
8.1.2 Information flows . 35
8.1.2.1 Onboard API invoker request . 35
8.1.2.2 Onboard API invoker response . 35
8.1.3 Procedure . 35
8.2 Offboarding the API invoker from the CAPIF . 36
8.2.1 General . 36
8.2.2 Information flows . 36
8.2.2.1 Offboard API invoker request . 37
ETSI

---------------------- Page: 5 ----------------------
3GPP TS 23.222 version 16.10.0 Release 16 5 ETSI TS 123 222 V16.10.0 (2021-07)
8.2.2.2 Offboard API invoker response . 37
8.2.3 Procedure . 37
8.3 Publish service APIs . 38
8.3.1 General . 38
8.3.2 Information flows . 38
8.3.2.1 Service API publish request . 38
8.3.2.2 Service API publish response . 38
8.3.3 Procedure . 38
8.4 Unpublish service APIs . 39
8.4.1 General . 39
8.4.2 Information flows . 39
8.4.2.1 Service API unpublish request . 39
8.4.2.2 Service API unpublish response . 40
8.4.3 Procedure . 40
8.5 Retrieve service APIs . 40
8.5.1 General . 40
8.5.2 Information flows . 41
8.5.2.1 Service API get request . 41
8.5.2.2 Service API get response . 41
8.5.3 Procedure . 41
8.6 Update service APIs . 42
8.6.1 General . 42
8.6.2 Information flows . 42
8.6.2.1 Service API update request . 42
8.6.2.2 Service API update response . 42
8.6.3 Procedure . 43
8.7 Discover service APIs . 43
8.7.1 General . 43
8.7.2 Information flows . 43
8.7.2.1 Service API discover request . 43
8.7.2.2 Service API discover response . 44
8.7.3 Procedure . 44
8.8 Subscription, unsubscription and notifications for the CAPIF events . 45
8.8.1 General . 45
8.8.2 Information flows . 46
8.8.2.1 Event subscription request .
...