You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- How to get started with SAP Business Accelerator Hub
12
+
# Tour the SAP API Business Hub
13
+
<!-- description --> Explore the various features of the SAP API Business Hub, and learn how to find and test APIs.
16
14
17
-
SAP Business Accelerator Hub is a website to discover, explore, and test APIs from various SAP products such as SAP S/4HANA, SAP SuccessFactors, SAP Customer Experience, SAP BTP, and selected partners. Apart from various product APIs, you can find detailed information on business processes and partner assets. The new workspace feature also enables you to consume integration and workflow content.
15
+
## You will learn
16
+
- How to get started with SAP API Business Hub
18
17
19
-
Want to learn more about the new SAP Business Accelerator Hub? Not sure where to get started? Go to [api.sap.com] (https://api.sap.com), and begin your journey.
18
+
## Intro
19
+
SAP API Business Hub is a website to discover, explore, and test APIs from various SAP products such as SAP S/4HANA, SAP SuccessFactors, SAP Customer Experience, SAP BTP, and selected partners. Apart from various product APIs, you can find detailed information on business processes and partner assets. The new workspace feature also enables you to consume integration and workflow content.
20
20
21
-
---
22
-
23
-
[ACCORDION-BEGIN [Step: 1](Go to the SAP Business Accelerator Hub)]
24
-
In your browser, open [SAP Business Accelerator Hub](https://api.sap.com/).
21
+
Want to learn more about the new SAP API Business Hub? Not sure where to get started? Go to [api.sap.com] (https://api.sap.com), and begin your journey.
25
22
26
-
!
23
+
---
27
24
28
-
You can explore products, business processes, as well as different categories of assets, along with partner and featured content. Choose Explore for quick access to the various sections of the SAP Business Accelerator Hub.
25
+
### Go to the SAP API Business Hub
26
+
In your browser, open [SAP API Business Hub](https://api.sap.com/).
29
27
30
-
[DONE]
31
-
[ACCORDION-END]
28
+
<!-- border -->
32
29
30
+
You can explore products, business processes, as well as different categories of assets, along with partner and featured content. Choose Explore for quick access to the various sections of the SAP API Business Hub.
33
31
34
-
[ACCORDION-BEGIN [Step : 2](Explore API content)]
35
-
On the SAP Business Accelerator Hub homepage, choose **Categories**.
32
+
### Explore API content
33
+
On the SAP API Business Hub homepage, choose **Categories**.
36
34
37
-
!
35
+
<!-- border -->
38
36
39
37
Choose APIs from the different categories available.
40
38
41
-
!
39
+
<!-- border -->
42
40
43
-
[DONE]
44
-
[ACCORDION-END]
45
-
[ACCORDION-BEGIN [Step : 3](Search for an API)]
41
+
### Search for an API
46
42
47
43
Different APIs, policy templates, and API packages are available under the API category. An API package contains one or more APIs. You can browse through different types of APIs such as REST, OData, and SOAP APIs.
48
44
49
-
!
45
+
<!-- border -->
50
46
51
47
You can explore APIs either by selecting a type of an API or by selecting an API package. Navigate to the Packages tab. You can choose any package for testing.
52
48
53
-
!
49
+
<!-- border -->
54
50
55
51
For the purpose of this tutorial, we are going to choose the `SAP Cloud for Customer` package (find it using the search facility).
56
52
57
-
!
58
-
53
+
<!-- border -->
59
54
60
-
[DONE]
61
-
[ACCORDION-END]
62
-
63
-
64
-
[ACCORDION-BEGIN [Step : ](Explore the API)]
55
+
### Explore the API
65
56
66
57
On choosing the **SAP Cloud for Customer** package, you can view the available APIs in the package. Select the Campaign API to explore it in detail.
67
58
68
-
!
59
+
<!-- border -->
69
60
70
61
The **`Overview`** section briefs you about the API. From here you can download the API reference file, view the documentation available, and check for the API version.
71
62
72
63
The **`API Reference`** section provides information and functions that are offered to consume the API.
73
64
74
-
!
65
+
<!-- border -->
75
66
76
67
The API can contain one or more endpoints which are organized into groups. On the left-hand side of selected API - **Campaign**, you can see six groups of endpoints.
77
68
78
-
!
69
+
<!-- border -->
79
70
80
71
Various HTTP methods of API are used to address the functionality of endpoints. While exploring the endpoints, you may wish to collapse the information by selecting the `GET` operation row. You can explore the available endpoints for the API to understand it in detail.
81
72
82
-
[DONE]
83
-
[ACCORDION-END]
73
+
### Test an API endpoint
84
74
85
-
[ACCORDION-BEGIN [Step : 5](Test an API endpoint)]
75
+
The SAP API Business Hub allows you to test APIs. A sandbox environment is provided to test the Campaign API. To take advantage of this, ensure you are logged on. Select Login at the top of the page.
86
76
87
-
The SAP Business Accelerator Hub allows you to test APIs. A sandbox environment is provided to test the Campaign API. To take advantage of this, ensure you are logged on. Select Login at the top of the page.
88
-
89
-
!
77
+
<!-- border -->
90
78
91
79
Once logged on, choose the Try Out button in the **`Overview`** section.
92
80
93
-
!
81
+
<!-- border -->
94
82
95
83
Selecting this will open the Try Out View.
96
84
97
85
For the purpose of this tutorial the **`GET /CampaignCollection`** operation has been selected for testing.
98
86
99
-
!
87
+
<!-- border -->
100
88
101
89
Calling the `GET` operation on the `/CampaignCollection` endpoint will return a list of entities from Campaign Collection. The `$top` parameter can be used to retrieve only the first _n_ results once all the other filtering is done. Specify a value of **20** for this parameter.
102
90
103
-
!
91
+
<!-- border -->
104
92
105
93
You can also select the `$orderby` to sort the display order based on `Object ID`, `Object ID description`, `Campaign Type`, and so on.
106
94
107
95
Once the required inputs are entered, Choose `Run` at the top right corner to view the response.
108
96
109
-
!
97
+
<!-- border -->
110
98
111
99
The response section displays various entities fetched calling the `GET` method.
112
100
113
-
!
101
+
<!-- border -->
114
102
115
103
116
104
Feel free to explore other endpoints in this Campaign API.
117
105
118
-
[VALIDATE_4]
119
-
[ACCORDION-END]
120
-
121
-
Congratulations, you have just taken your first steps with the SAP Business Accelerator Hub and should now be able to navigate it and the content within, confidently.
106
+
Congratulations, you have just taken your first steps with the SAP API Business Hub and should now be able to navigate it and the content within, confidently.
0 commit comments