Create API Groups and Add API Instances

To package a set of APIs, you first create an API Group and then add the relevant API instances to the group. If you want your API Group to be discovered by consumers, you must publish it to Exchange.

Using the following information, you create an API Group, including creating an API Group, creating the very first version of that group, and creating the very first group instance. Additionally, you add API instances to the API Group instance.

You can add API instances to the API Group instance based on the environment (production, sandbox, or others) in which you create the API Group instance. For example, if you created an API Group instance in a production environment, you can add API instances to the API Group instance only from production.

You create API Groups using the following steps:

+ The first step to creating an API Group that can be used by consumers is to create an API Group. .Add API instances to the new API Group

+ After you create the API Group, you then add API instances to this group for the first time.

Task Prerequisites

Before you begin, you must have:

  • At least one API instance in your organization or business group

    Otherwise, you will not be able to find the required organization or business group in the list.

  • API Group Administrator permissions to create API Groups

Create API Groups

You create an API Group at the organization level.

To create API Groups:

  1. From the left menu in API Manager, click API Groups > Create API Groups.

  2. In the API Group name field, specify a name for the API Group that you want to create: for example, Social Chatter.

  3. In the API Group version field, specify the version for the API Group: for example, v1.

  4. Optionally, in the API Group instance label field, specify a label for the API Group, such as Internal if you want to use it for internal purposes.

  5. Click Continue.

The Creating a new group page is displayed. You are now ready to add API instances to the API Group.

Add API Instances to API Groups

Your API Group is not functional until you add the API instances to the group that you want to bundle. When you add API instances to an API Group, you can add:

  • Only those API instances that belong in the same business group or organizations

  • Only those API instances that belong to same environment type as the API Group instance

  • Only those API instances that belong to the same identity provider (IdP)

    You cannot mix IdPs in an API Group instance.

To add a new API instance to a new API Group:

  1. On the Creating a new group page, select an environment from the Select environment drop-down list:

    The screen capture shows how to add API instance to an API Group.

    Adding API instances to API Groups

    1 The organization under which the API Group is created
    2 The Add button to add more API instances to the group
    3 The Add Organization button to add organizations to the group
    4 The Save button
    5 The Delete button to instantly delete an API instance from the group
  2. From the Select an API list, select the API instance that you want to add.

  3. From the Select a version / instance list, select the version of the API Instance that you want to add to the group.

  4. If you want to include additional API instances in the API Group, click Add and specify the details.

  5. If the API instance and the API Group belong in different business groups:

    1. Click Add Organization.

    2. Select the organization or business group in which your API instance is available and click Add.

    3. Select the environment, API instance, and version that you want to add.

  6. Click Save.

    Your API instances are now added to the API Group.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub