Skip to Content

API Groups page in Jitterbit API Manager

Introduction

The API Groups page within API Manager allows a Harmony organization administrator to create and manage a group of APIs that external users can access.

Alternatively, create and manage API groups using the APIM AI Assistant.

Note

To use the APIM AI Assistant, your Harmony license must include the APIM AI Assistant option. Contact your Customer Success Manager (CSM) to add this option to your license.

To perform actions or make edits on the API Groups page, a role with Admin permission is required. Users in roles with Write environment access can open the page but cannot view the contents.

Access the API Groups page

To access the API Groups page, use the Harmony portal menu to select API Manager > API Groups.

API Groups page header

The header along the top of the API Groups page includes a search box and a button for creating a new API group:

header

  • Search: Enter any part of an API group's name into the search box to filter API groups by name. The search is not case-sensitive.

  • New: Click to select one of the following options:

    • Build with AI: Opens the APIM Assistant to create an API group using natural language prompts. For more information, see Use the AI Assistant.

      Note

      To use the APIM AI Assistant, your Harmony license must include the APIM AI Assistant option. Contact your Customer Success Manager (CSM) to add this option to your license.

    • API Group: Opens the API group configuration to manually create a new API group.

Create an API group

When you select API Group from the New menu in the page header, this user interface opens:

add new group

  • API group name: Enter a name to identify the API group.

  • Environment: Select the environment to include all APIs in that environment in the API group.

  • API: One at a time, select an API to include in the API group. Clicking the name of an individual API reveals additional information about the API in the right panel, such as the version of the API, the service URL, and the operations assigned to the API.

  • Save: Click to save the API group and to close the configuration.

  • Cancel: Click to discard the API group and to close the configuration.

API groups

Existing API groups are displayed as follows and have these options:

API groups

  • View: Click to view additional details about the API group.

  • Edit: Click to add or remove the APIs in the API group.

  • Delete: Click to delete the API group.

View an API group

When viewing an API group, you are presented with this user interface:

view API groups

  • API: The name of the API.

  • Version: The version of the API.

  • Environment: The environment of the API.

  • Path: The URL prefix, API version, and service root of the API service URL.

  • Copy: Click to copy the Path to your clipboard.