8.3 Publish service APIs

23.2223GPPCommon API Framework for 3GPP Northbound APIsRelease 18TS

8.3.1 General

The CAPIF supports publishing service APIs by the API provider. The API publishing function can be within PLMN trust domain or within 3^rd party trust domain.

8.3.2 Information flows

8.3.2.1 Service API publish request

Table 8.3.2.1-1 describes the information flow service API publish request from the API publishing function to the CAPIF core function.

Table 8.3.2.1-1: Service API publish request

Information element	Status	Description
API publisher information	M	The information of the API publisher may include identity, authentication and authorization information
Service API information	M	The service API information includes the service API name, API provider name (optional), service API type, communication type, description, Serving Area Information (optional), AEF location (optional), interface details (e.g. IP address, port number, URI), protocols, version numbers, and data format.
Shareable information	O (see NOTE)	Indicates whether the service API or the service API category can be published to other CCFs. And if sharing, a list of CAPIF provider domain information where the service API or the service API category can be published is contained.
NOTE: If the shareable information is not present, the service API is not allowed to be shared.

8.3.2.2 Service API publish response

Table 8.3.2.2-1 describes the information flow service API publish response from the CAPIF core function to the API publishing function.

Table 8.3.2.2-1: Service API publish response

Information element	Status	Description
Result	M	Indicates the success or failure of publishing the service API information
Service API published information reference	O (see NOTE)	The information which can be used for referencing the information (set) about the published service API by the API publishing function.
NOTE: This information element is included when the Result indicates success.

8.3.3 Procedure

Figure 8.3.3-1 illustrates the procedure for publishing the service APIs. The service API publish mechanism is supported by the CAPIF core function.

Pre-conditions:

1. Authorization details of the APF are available with the CAPIF core function.

2. API invokers may have subscribed with the CAPIF core function to obtain new service API information.

Figure 8.3.3-1: Publish service APIs

1. The API publishing function sends a service API publish request to the CAPIF core function, with the details of the service API. If the service API is to be shared to other CAPIF core functions, the shareable information and the CAPIF provider domain information are included.

2. Upon receiving the service API publish request, the CAPIF core function checks whether the API publishing function is authorized to publish service APIs. If the check is successful, the service API information provided by the API publishing function is stored at the CAPIF core function (API registry).

3. The CAPIF core function provides a service API publish response to the API publishing function indicating success or failure result and triggers notifications to subscribed API invokers as described in subclause 8.8.4.