NONRTRIC-998: Servicemanager - Add API Docs
[nonrtric/plt/sme.git] / postman / CAPIF.postman_collection.json
1 {
2         "info": {
3                 "_postman_id": "1bdb5498-440f-4bdd-ad8d-bea853343cdc",
4                 "name": "CAPIF",
5                 "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
6                 "_exporter_id": "30653024"
7         },
8         "item": [
9                 {
10                         "name": "1. Register provider Domain",
11                         "item": [
12                                 {
13                                         "name": "1.- rApp registers as provider domain",
14                                         "request": {
15                                                 "method": "POST",
16                                                 "header": [],
17                                                 "body": {
18                                                         "mode": "raw",
19                                                         "raw": "{\n    \"apiProvDomInfo\": \"Provider domain\",\n    \"apiProvFuncs\": [\n        {\n            \"apiProvFuncInfo\": \"rApp as APF\",\n            \"apiProvFuncRole\": \"APF\",\n            \"regInfo\": {\n                \"apiProvPubKey\": \"APF-PublicKey\"\n            }\n        },\n        {\n            \"apiProvFuncInfo\": \"rApp as AEF\",\n            \"apiProvFuncRole\": \"AEF\",\n            \"regInfo\": {\n                \"apiProvPubKey\": \"AEF-PublicKey\"\n            }\n        },\n        {\n            \"apiProvFuncInfo\": \"rApp as AMF\",\n            \"apiProvFuncRole\": \"AMF\",\n            \"regInfo\": {\n                \"apiProvPubKey\": \"AMF-PublicKey\"\n            }\n        },\n        {\n            \"apiProvFuncInfo\": \"Gateway as entrypoint AEF\",\n            \"apiProvFuncRole\": \"AEF\",\n            \"regInfo\": {\n                \"apiProvPubKey\": \"AEF-Gateway-PublicKey\"\n            }\n        }\n    ],\n    \"regSec\": \"PSK\"\n}",
20                                                         "options": {
21                                                                 "raw": {
22                                                                         "language": "json"
23                                                                 }
24                                                         }
25                                                 },
26                                                 "url": {
27                                                         "raw": "http://localhost:8090/api-provider-management/v1/registrations",
28                                                         "protocol": "http",
29                                                         "host": [
30                                                                 "localhost"
31                                                         ],
32                                                         "port": "8090",
33                                                         "path": [
34                                                                 "api-provider-management",
35                                                                 "v1",
36                                                                 "registrations"
37                                                         ]
38                                                 },
39                                                 "description": "StartFragment\n\nRegisters a new API Provider domain with API provider domain functions profiles.\n\nEndFragme"
40                                         },
41                                         "response": []
42                                 }
43                         ],
44                         "description": "The CAPIF API provider management APIs, as defined in 3GPP TS 23.222 \\[2\\], allow API management functions via CAPIF-5 and CAPIF-5e reference points to register, deregister and update registration information of API provider domain functions (API Exposing Function, API Publishing Function, API management Function) as a recognized API provider domain of the CAPIF domain.\n\n| Service operation name | Description |\n| --- | --- |\n| Register_API_Provider | This service operation is used by an API management function to register API provider domain functions as a recognized API provider domain of the CAPIF domain. |\n| Update_API_Provider | This service operation is used by an API management function to update the API provider domain functions details in the CAPIF domain. |\n| Deregister_API_Provider | This service operation is used by an API management function to deregister API provider domain functions as a recognized API provider domain of the CAPIF domain. |"
45                 },
46                 {
47                         "name": "2. Publish APIs",
48                         "item": [
49                                 {
50                                         "name": "1. rApp publishes its API example A",
51                                         "request": {
52                                                 "method": "POST",
53                                                 "header": [],
54                                                 "body": {
55                                                         "mode": "raw",
56                                                         "raw": "{\n    \"apiName\": \"example A\",\n    \"description\": \"Example A API of rApp\",\n    \"aefProfiles\": [\n        {\n            \"aefId\": \"AEF_id_rApp_as_AEF\",\n            \"description\": \"Example A rApp as AEF\",\n            \"versions\": [\n                {\n                    \"apiVersion\": \"v1\",\n                    \"resources\": [\n                        {\n                            \"resourceName\": \"exampleA\",\n                            \"commType\": \"REQUEST_RESPONSE\",\n                            \"uri\": \"/exampleA/subscription/subscription_id_1\",\n                            \"operations\": [\n                                \"GET\"\n                            ]\n                        }\n                    ]\n                }\n            ],\n            \"protocol\": \"HTTP_1_1\",\n\t\t\t\"securityMethods\": [\"PSK\"],\n\t\t\t\"interfaceDescriptions\": [\n\t\t\t\t{\n\t\t\t\t  \"ipv4Addr\": \"string\",\n\t\t\t\t  \"port\": 65535,\n\t\t\t\t  \"securityMethods\": [\"PKI\"]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t  \"ipv4Addr\": \"string\",\n\t\t\t\t  \"port\": 65535,\n\t\t\t\t  \"securityMethods\": [\"PKI\"]\n\t\t\t\t}\n\t\t\t  ]\n        }\n    ]\n}",
57                                                         "options": {
58                                                                 "raw": {
59                                                                         "language": "json"
60                                                                 }
61                                                         }
62                                                 },
63                                                 "url": {
64                                                         "raw": "http://localhost:8090/published-apis/v1/APF_id_rApp_as_APF/service-apis",
65                                                         "protocol": "http",
66                                                         "host": [
67                                                                 "localhost"
68                                                         ],
69                                                         "port": "8090",
70                                                         "path": [
71                                                                 "published-apis",
72                                                                 "v1",
73                                                                 "APF_id_rApp_as_APF",
74                                                                 "service-apis"
75                                                         ]
76                                                 },
77                                                 "description": "Publish a new API"
78                                         },
79                                         "response": []
80                                 },
81                                 {
82                                         "name": "2. rApp publishes its API example B",
83                                         "request": {
84                                                 "method": "POST",
85                                                 "header": [],
86                                                 "body": {
87                                                         "mode": "raw",
88                                                         "raw": "{\n    \"apiName\": \"example B\",\n    \"description\": \"Example B API of rApp\",\n    \"aefProfiles\": [\n        {\n            \"aefId\": \"AEF_id_rApp_as_AEF\",\n            \"description\": \"Example B rApp as AEF\",\n            \"versions\": [\n                {\n                    \"apiVersion\": \"v1\",\n                    \"resources\": [\n                        {\n                            \"resourceName\": \"exampleB\",\n                            \"commType\": \"REQUEST_RESPONSE\",\n                            \"uri\": \"/exampleB/subscription/subscription_id_1\",\n                            \"operations\": [\n                                \"GET\"\n                            ]\n                        }\n                    ]\n                }\n            ],\n            \"protocol\": \"HTTP_1_1\",\n\t\t\t\"securityMethods\": [\"PSK\"],\n\t\t\t\"interfaceDescriptions\": [\n\t\t\t\t{\n\t\t\t\t  \"ipv4Addr\": \"string\",\n\t\t\t\t  \"port\": 65535,\n\t\t\t\t  \"securityMethods\": [\"PKI\"]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t  \"ipv4Addr\": \"string\",\n\t\t\t\t  \"port\": 65535,\n\t\t\t\t  \"securityMethods\": [\"PKI\"]\n\t\t\t\t}\n\t\t\t  ]\n        }\n    ]\n}",
89                                                         "options": {
90                                                                 "raw": {
91                                                                         "language": "json"
92                                                                 }
93                                                         }
94                                                 },
95                                                 "url": {
96                                                         "raw": "http://localhost:8090/published-apis/v1/APF_id_rApp_as_APF/service-apis",
97                                                         "protocol": "http",
98                                                         "host": [
99                                                                 "localhost"
100                                                         ],
101                                                         "port": "8090",
102                                                         "path": [
103                                                                 "published-apis",
104                                                                 "v1",
105                                                                 "APF_id_rApp_as_APF",
106                                                                 "service-apis"
107                                                         ]
108                                                 },
109                                                 "description": "Publish a new API"
110                                         },
111                                         "response": []
112                                 },
113                                 {
114                                         "name": "3. rApp updates published API example A",
115                                         "request": {
116                                                 "method": "PUT",
117                                                 "header": [],
118                                                 "body": {
119                                                         "mode": "raw",
120                                                         "raw": "{\n    \"apiName\": \"example A\",\n    \"description\": \"Example A API of rApp\",\n    \"aefProfiles\": [\n        {\n            \"aefId\": \"AEF_id_rApp_as_AEF\",\n            \"description\": \"Example A rApp as AEF\",\n            \"versions\": [\n                {\n                    \"apiVersion\": \"v1\",\n                    \"resources\": [\n                        {\n                            \"resourceName\": \"exampleA\",\n                            \"commType\": \"REQUEST_RESPONSE\",\n                            \"uri\": \"/exampleA/subscription/subscription_id_1\",\n                            \"operations\": [\n                                \"GET\"\n                            ]\n                        }\n                    ]\n                },\n                {\n                    \"apiVersion\": \"v2\",\n                    \"resources\": [\n                        {\n                            \"resourceName\": \"exampleA\",\n                            \"commType\": \"REQUEST_RESPONSE\",\n                            \"uri\": \"/exampleA/subscription/subscription_id_2\",\n                            \"operations\": [\n                                \"GET\"\n                            ]\n                        }\n                    ]\n                }\n            ],\n            \"protocol\": \"HTTP_1_1\",\n\t\t\t\"securityMethods\": [\"PSK\"],\n\t\t\t\"interfaceDescriptions\": [\n\t\t\t\t{\n\t\t\t\t  \"ipv4Addr\": \"string\",\n\t\t\t\t  \"port\": 65535,\n\t\t\t\t  \"securityMethods\": [\"PKI\"]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t  \"ipv4Addr\": \"string\",\n\t\t\t\t  \"port\": 65535,\n\t\t\t\t  \"securityMethods\": [\"PKI\"]\n\t\t\t\t}\n\t\t\t  ]\n        }\n    ]\n}",
121                                                         "options": {
122                                                                 "raw": {
123                                                                         "language": "json"
124                                                                 }
125                                                         }
126                                                 },
127                                                 "url": {
128                                                         "raw": "http://localhost:8090/published-apis/v1/APF_id_rApp_as_APF/service-apis/api_id_example_A?serviceApiId =api_id_example_A&apfId =APF_id_rApp_as_APF",
129                                                         "protocol": "http",
130                                                         "host": [
131                                                                 "localhost"
132                                                         ],
133                                                         "port": "8090",
134                                                         "path": [
135                                                                 "published-apis",
136                                                                 "v1",
137                                                                 "APF_id_rApp_as_APF",
138                                                                 "service-apis",
139                                                                 "api_id_example_A"
140                                                         ],
141                                                         "query": [
142                                                                 {
143                                                                         "key": "serviceApiId ",
144                                                                         "value": "api_id_example_A"
145                                                                 },
146                                                                 {
147                                                                         "key": "apfId ",
148                                                                         "value": "APF_id_rApp_as_APF"
149                                                                 }
150                                                         ]
151                                                 },
152                                                 "description": "Update a published service API"
153                                         },
154                                         "response": []
155                                 },
156                                 {
157                                         "name": "4. rApp delete an API",
158                                         "request": {
159                                                 "method": "DELETE",
160                                                 "header": [],
161                                                 "url": {
162                                                         "raw": "http://localhost:8090/published-apis/v1/APF_id_rApp_as_APF/service-apis/api_id_example?serviceApiId =api_id_example_B&apfId =APF_id_rApp_as_APF",
163                                                         "protocol": "http",
164                                                         "host": [
165                                                                 "localhost"
166                                                         ],
167                                                         "port": "8090",
168                                                         "path": [
169                                                                 "published-apis",
170                                                                 "v1",
171                                                                 "APF_id_rApp_as_APF",
172                                                                 "service-apis",
173                                                                 "api_id_example"
174                                                         ],
175                                                         "query": [
176                                                                 {
177                                                                         "key": "serviceApiId ",
178                                                                         "value": "api_id_example_B"
179                                                                 },
180                                                                 {
181                                                                         "key": "apfId ",
182                                                                         "value": "APF_id_rApp_as_APF"
183                                                                 }
184                                                         ]
185                                                 },
186                                                 "description": "Unpublish a published service API"
187                                         },
188                                         "response": []
189                                 }
190                         ],
191                         "description": "The CAPIF publish service APIs, as defined in 3GPP TS 23.222 \\[2\\], allow API publishing function via CAPIF-4 and CAPIF-4e reference points to publish and manage published service APIs at the CAPIF core function, and allow CAPIF core function via CAPIF-6 and CAPIF-6e reference points to publish and manage published service APIs at other CAPIF core function.\n\n| **Service operation name** | **Description** |\n| --- | --- |\n| Publish_Service_API | This service operation is used by an API publishing function to publish service APIs on the CAPIF core function. This service operation is also used by CAPIF core function to publish service APIs on other CAPIF core function. |\n| Unpublish_Service_API | This service operation is used by an API publishing function to un-publish service APIs from the CAPIF core function. This service operation is also used by CAPIF core function to un-publish service APIs on other CAPIF core function. |\n| Get_Service_API | This service operation is used by an API publishing function to retrieve service APIs from the CAPIF core function. This service operation is also used by CAPIF core function to retrieve service APIs on other CAPIF core function. |\n| Update_Service_API | This service operation is used by an API publishing function to update published service APIs on the CAPIF core function. This service operation is also used by CAPIF core function to update published service APIs on other CAPIF core function. |"
192                 },
193                 {
194                         "name": "3. Invoker Management",
195                         "item": [
196                                 {
197                                         "name": "1. rApp onboards itself as invoker",
198                                         "request": {
199                                                 "method": "POST",
200                                                 "header": [],
201                                                 "body": {
202                                                         "mode": "raw",
203                                                         "raw": "{\n    \"apiInvokerInformation\": \"rApp as invoker 1\",\n\t \"apiList\": [\n\t\t{}\n\t],\n    \"NotificationDestination\": \"http://invoker-app:8086/callback\",\n    \"onboardingInformation\": {\n\t\t\"apiInvokerPublicKey\": \"{PUBLIC_KEY_INVOKER_1}\",\n\t\t\"apiInvokerCertificate\": \"apiInvokerCertificate\"\n  },\n  \"requestTestNotification\": true\n}",
204                                                         "options": {
205                                                                 "raw": {
206                                                                         "language": "json"
207                                                                 }
208                                                         }
209                                                 },
210                                                 "url": {
211                                                         "raw": "http://localhost:8090/api-invoker-management/v1/onboardedInvokers",
212                                                         "protocol": "http",
213                                                         "host": [
214                                                                 "localhost"
215                                                         ],
216                                                         "port": "8090",
217                                                         "path": [
218                                                                 "api-invoker-management",
219                                                                 "v1",
220                                                                 "onboardedInvokers"
221                                                         ]
222                                                 },
223                                                 "description": "Creates a new individual API Invoker profile."
224                                         },
225                                         "response": []
226                                 },
227                                 {
228                                         "name": "2. rApp onboards itself as invoker2",
229                                         "request": {
230                                                 "method": "POST",
231                                                 "header": [],
232                                                 "body": {
233                                                         "mode": "raw",
234                                                         "raw": "{\n    \"apiInvokerInformation\": \"rApp as invoker 2\",\n\t \"apiList\": [\n\t\t{}\n\t],\n    \"NotificationDestination\": \"http://invoker2-app:8086/callback\",\n    \"onboardingInformation\": {\n\t\t\"apiInvokerPublicKey\": \"{PUBLIC_KEY_INVOKER_2}\",\n\t\t\"apiInvokerCertificate\": \"apiInvokerCertificate\"\n  },\n  \"requestTestNotification\": true\n}",
235                                                         "options": {
236                                                                 "raw": {
237                                                                         "language": "json"
238                                                                 }
239                                                         }
240                                                 },
241                                                 "url": {
242                                                         "raw": "http://localhost:8090/api-invoker-management/v1/onboardedInvokers",
243                                                         "protocol": "http",
244                                                         "host": [
245                                                                 "localhost"
246                                                         ],
247                                                         "port": "8090",
248                                                         "path": [
249                                                                 "api-invoker-management",
250                                                                 "v1",
251                                                                 "onboardedInvokers"
252                                                         ]
253                                                 },
254                                                 "description": "Creates a new individual API Invoker profile"
255                                         },
256                                         "response": []
257                                 },
258                                 {
259                                         "name": "3. rApp invoker delete",
260                                         "request": {
261                                                 "method": "DELETE",
262                                                 "header": [],
263                                                 "url": {
264                                                         "raw": "http://localhost:8090/api-invoker-management/v1/onboardedInvokers/api_invoker_id_rApp_as_invoker_2?onboardingId=api_invoker_id_rApp_as_invoker_2",
265                                                         "protocol": "http",
266                                                         "host": [
267                                                                 "localhost"
268                                                         ],
269                                                         "port": "8090",
270                                                         "path": [
271                                                                 "api-invoker-management",
272                                                                 "v1",
273                                                                 "onboardedInvokers",
274                                                                 "api_invoker_id_rApp_as_invoker_2"
275                                                         ],
276                                                         "query": [
277                                                                 {
278                                                                         "key": "onboardingId",
279                                                                         "value": "api_invoker_id_rApp_as_invoker_2"
280                                                                 }
281                                                         ]
282                                                 },
283                                                 "description": "Deletes an individual API invoker"
284                                         },
285                                         "response": []
286                                 }
287                         ],
288                         "description": "The CAPIF API invoker management APIs, as defined in 3GPP TS 23.222 \\[2\\], allow API invokers via CAPIF-1/1e reference points to on-board and off-board itself as a recognized user of the CAPIF or update the API invoker's details on the CAPIF core function.\n\n| **Service operation name** | **Description** |\n| --- | --- |\n| Onboard_API_Invoker | This service operation is used by an API invoker to on-board itself as a recognized user of CAPIF |\n| Offboard_API_Invoker | This service operation is used by an API invoker to off-board itself as a recognized user of CAPIF |\n| Update_API_Invoker_Details | This service operation is used by an API invoker to update API invoker's details in the CAPIF core function. |"
289                 },
290                 {
291                         "name": "4. Discover Service API",
292                         "item": [
293                                 {
294                                         "name": "1. Invoker discovers APIs",
295                                         "request": {
296                                                 "method": "GET",
297                                                 "header": [],
298                                                 "url": {
299                                                         "raw": "http://localhost:8090/service-apis/v1/allServiceAPIs?api-invoker-id=api_invoker_id_rApp_as_invoker_1",
300                                                         "protocol": "http",
301                                                         "host": [
302                                                                 "localhost"
303                                                         ],
304                                                         "port": "8090",
305                                                         "path": [
306                                                                 "service-apis",
307                                                                 "v1",
308                                                                 "allServiceAPIs"
309                                                         ],
310                                                         "query": [
311                                                                 {
312                                                                         "key": "aef-id",
313                                                                         "value": "",
314                                                                         "disabled": true
315                                                                 },
316                                                                 {
317                                                                         "key": "api-cat",
318                                                                         "value": "",
319                                                                         "disabled": true
320                                                                 },
321                                                                 {
322                                                                         "key": "api-name",
323                                                                         "value": "",
324                                                                         "disabled": true
325                                                                 },
326                                                                 {
327                                                                         "key": "api-version",
328                                                                         "value": "",
329                                                                         "disabled": true
330                                                                 },
331                                                                 {
332                                                                         "key": "comm-type",
333                                                                         "value": "",
334                                                                         "disabled": true
335                                                                 },
336                                                                 {
337                                                                         "key": "data-format",
338                                                                         "value": "",
339                                                                         "disabled": true
340                                                                 },
341                                                                 {
342                                                                         "key": "preferred-aef-loc",
343                                                                         "value": "",
344                                                                         "disabled": true
345                                                                 },
346                                                                 {
347                                                                         "key": "protocol",
348                                                                         "value": "",
349                                                                         "disabled": true
350                                                                 },
351                                                                 {
352                                                                         "key": "supported-features",
353                                                                         "value": "",
354                                                                         "disabled": true
355                                                                 },
356                                                                 {
357                                                                         "key": "api-invoker-id",
358                                                                         "value": "api_invoker_id_rApp_as_invoker_1"
359                                                                 }
360                                                         ]
361                                                 }
362                                         },
363                                         "response": []
364                                 }
365                         ]
366                 },
367                 {
368                         "name": "5. Security API",
369                         "item": [
370                                 {
371                                         "name": "1. Invoker obtains security context",
372                                         "request": {
373                                                 "method": "PUT",
374                                                 "header": [],
375                                                 "body": {
376                                                         "mode": "raw",
377                                                         "raw": "{\r\n  \"notificationDestination\": \"http://invoker-app:8086/callback\",\r\n  \"supportedFeatures\": \"fffffff\",\r\n  \"securityInfo\": [\r\n    {\r\n      \"aefId\": \"AEF_id_rApp_as_AEF\",\r\n      \"apiId\": \"api_id_example\",\r\n      \"interfaceDetails\": \r\n        {\r\n            \"ipv4Addr\": \"string\",\r\n            \"port\": 65535,\r\n            \"securityMethods\": [\r\n                \"PKI\"\r\n            ]\r\n        },\r\n      \"prefSecurityMethods\": [\r\n        \"PKI\"\r\n      ]\r\n    }\r\n  ],\r\n  \"requestTestNotification\": true\r\n}",
378                                                         "options": {
379                                                                 "raw": {
380                                                                         "language": "json"
381                                                                 }
382                                                         }
383                                                 },
384                                                 "url": {
385                                                         "raw": "http://localhost:8090/capif-security/v1/trustedInvokers/api_invoker_id_rApp_as_invoker_1",
386                                                         "protocol": "http",
387                                                         "host": [
388                                                                 "localhost"
389                                                         ],
390                                                         "port": "8090",
391                                                         "path": [
392                                                                 "capif-security",
393                                                                 "v1",
394                                                                 "trustedInvokers",
395                                                                 "api_invoker_id_rApp_as_invoker_1"
396                                                         ]
397                                                 }
398                                         },
399                                         "response": []
400                                 },
401                                 {
402                                         "name": "2. Invoker rApp retrieves OAuth access token",
403                                         "request": {
404                                                 "method": "POST",
405                                                 "header": [],
406                                                 "body": {
407                                                         "mode": "urlencoded",
408                                                         "urlencoded": [
409                                                                 {
410                                                                         "key": "client_id",
411                                                                         "value": "api_invoker_id_rApp_as_invoker_1",
412                                                                         "type": "text"
413                                                                 },
414                                                                 {
415                                                                         "key": "client_secret",
416                                                                         "value": "k5XSlZIywPUDesZloCCHIxSlrcYX0OBC",
417                                                                         "type": "text"
418                                                                 },
419                                                                 {
420                                                                         "key": "grant_type",
421                                                                         "value": "client_credentials",
422                                                                         "type": "text"
423                                                                 },
424                                                                 {
425                                                                         "key": "scope",
426                                                                         "value": "3gpp#aefId1:apiName1",
427                                                                         "type": "text",
428                                                                         "disabled": true
429                                                                 }
430                                                         ]
431                                                 },
432                                                 "url": {
433                                                         "raw": "http://localhost:8090/capif-security/v1/securities/api_invoker_id_rApp_as_invoker_1/token",
434                                                         "protocol": "http",
435                                                         "host": [
436                                                                 "localhost"
437                                                         ],
438                                                         "port": "8090",
439                                                         "path": [
440                                                                 "capif-security",
441                                                                 "v1",
442                                                                 "securities",
443                                                                 "api_invoker_id_rApp_as_invoker_1",
444                                                                 "token"
445                                                         ]
446                                                 }
447                                         },
448                                         "response": []
449                                 }
450                         ]
451                 }
452         ]
453 }