Updated on 2024-11-27 GMT+08:00

Creating an API Group

An API group is a set of APIs the same type of services use. An API developer creates an API group to manage all APIs in the group. Each API belongs to an API group. Before creating an API, create an API group.

Constraints

The system allocates a subdomain name to the API group for internal testing. The subdomain name can be accessed up to 1000 times a day. To give your users access to your APIs, bind independent domain names to their API group. Enable or disable API access by using the Debugging Domain Names switch. Turning off this switch will hide the debugging domain name, which is then displayed as --.

Prerequisites

Each API group must belong to an integration application. Before creating an API group, ensure that an integration application is available, or create one.

Procedure

  1. Log in to the ROMA Connect console. On the Instances page, click View Console of an instance.
  2. In the navigation pane on the left, choose API Connect > API Groups. In the upper right corner, click Create API Group and select Create Directly.
  3. On the page displayed, configure the following parameters and click OK.
    Table 1 API group parameters

    Parameter

    Description

    Name

    Enter an API group name. Using naming rules facilitates future search.

    Scope

    Specify who can view the API group.

    • Integration application: An API group belongs to a specific integration application. Only users who have permissions for this application can view and perform operations on the API group.
    • All: All users in the current instance can view and perform operations on the API group.

    Integration Application

    Mandatory for Scope set to Integration application.

    Select the API group's integration application. If none is available, click Create Integration Application on the right to create one.

    Description

    Enter a brief description of the API group.