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
Copy file name to clipboardExpand all lines: modules/ROOT/pages/api-groups-landing-page.adoc
+12-16Lines changed: 12 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ When you create an API Group, you can customize instances of that group with dif
9
9
10
10
Because each API Group instance can include several API instances, and each instance can be included in multiple API Group instance solutions, package customization options are limitless.
11
11
12
-
== How API Groups Works
12
+
== How API Groups Work
13
13
14
14
As an API Group Administrator, you create an API Group for a specific organization and environment. API Groups are versioned, like the APIs contained within them, to more easily incorporate updates.
15
15
@@ -31,9 +31,9 @@ This instance has 4 API instances: `Facebook v1` (PROD) and `Twitter v1` (PROD)
31
31
32
32
The API Group instance `QA` is published and an asset called `API Group Social Media V1` is created. If the API Group instance `PROD` is published, no asset is created. In this case, `PROD` is linked only to the existing asset because the API Group `Social Media` and the version `v1` are the same.
33
33
34
-
== Example Issue to Solve Using API Groups
34
+
== API Groups Example
35
35
36
-
To better understand how API Groups facilitates API consumer engagement, consider the needs of a fictitious company named Good Weather, which forecasts atmospheric conditions for a given location and time by using meteorology.
36
+
To better understand how API Groups facilitate API consumer engagement, consider the needs of a fictitious company named Good Weather, which forecasts atmospheric conditions for a given location and time by using meteorology.
37
37
38
38
Good Weather enables customers to access requested results using the following APIs:
39
39
@@ -47,7 +47,9 @@ Good Weather enables customers to access requested results using the following A
47
47
* Tropical API
48
48
* Translations API
49
49
50
-
Currently, the process that customers must follow to access and use the APIs is not efficient, requiring:
50
+
=== Example Problem Statement
51
+
52
+
The process that Good Weather customers follow to access and use the APIs is not efficient, requiring:
51
53
52
54
* Searching the Good Weather company portal to find appropriate APIs to actualize a business flow
53
55
+
@@ -59,9 +61,9 @@ This complicates the task of upgrading or downgrading of services.
59
61
+
60
62
The API packaging does not restrict access down to the individual call and data elements. This introduces security issues and unnecessary overhead.
61
63
62
-
==API Groups Solution
64
+
=== Example Solution using API Groups
63
65
64
-
Using API Groups, Good Weather can package different APIs based on consumer requirements and scenarios, with specific SLAs that do not clash with the requirements for other consumers. Good Weather can quickly adapt and absorb API changes. Using API Groups:
66
+
Using API Groups, Good Weather can package different APIs based on consumer requirements and scenarios, with specific SLAs that do not conflict with the requirements for other consumers. Good Weather can quickly adapt and absorb API changes. Using API Groups:
65
67
66
68
* Good Weather can package different sets of APIs to target different consumers' requirements.
67
69
* API consumers can access a collection of related APIs instead of individual APIs, simplifying asset discovery on the Good Weather portal.
@@ -81,24 +83,18 @@ The following table illustrates the API Group packages that Good Weather created
81
83
| | | Translations API
82
84
|===
83
85
84
-
== API Groups Permissions
86
+
== API Group Permissions
85
87
86
-
To perform all tasks pertaining to API groups, the API Group Administrator permissions is required. This permission is set at the business group-level and gives the user access to:
88
+
To perform all tasks pertaining to API groups, the API Group Administrator permission is required. This permission is set at the business group-level and gives the user access to:
87
89
88
90
* Create, update, and delete API Groups within the business group
89
91
* View all API instances in the business group to be able to add API instances to the API Group
90
92
* Configure SLA tiers and manage contracts with API Groups
0 commit comments