Organization APIs

Manage APIs associated with an organization on the API platform.

API Platform Version: 8.3

Table of Contents

  1. How do I manage APIs for my business organization on the platform?
  2. How do I add an API to an organization on the API platform?
  3. How do I view APIs for an organization on the API platform?
  4. How do I modify an API associated with an organization on the API platform?
  5. How do I move an API from one organization to another?
  6. How do I delete an API associated with an organization on the API platform?
  7. What roles can manage APIs for my business organization on the platform?
  8. Related Topics

How do I manage APIs for my business organization on the platform?

In the API platform, providing you have sufficient permissions, you can add and manage APIs at the root level.

  • In Default Theme, click the Plus menu and choose Add a New API, or click the My APIs icon to view the APIs list.
  • In Hermosa Theme, click the Plus sign and choose Add API.

The platform also supports setting up a business organization. You can then add apps and APIs at the organization level. You have full rights to manage these APIs, including:

To perform activities relating to apps and APIs at the organization level, you must first log in, and then choose the organization. You can then view and manage resources that were set up at the organization level.

Back to top

How do I add an API to an organization on the API platform?

Adding an API to a specific organization on the platform is essentially the same as adding an API at the root level. However, when you first specify an organization and then add the API within the context of the organization, the API visibility is limited to those who have visibility of the organization.

Only a Business Admin of the organization can add, modify, or delete APIs within the organization.

To add an API for a business organization:
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click APIs. All APIs associated with the organization are displayed.
  4. Click Add. The Add API page displays.
  5. Add an API in the same way as you would at the root organization level. For detailed instructions, see Adding an API.

Back to top

How do I view APIs for an organization on the API platform?

If you're a Business Admin, you have full rights to add, view, edit, or delete APIs that are set up for your organization.

To view APIs for an organization:
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click APIs. All APIs currently set up for the organization are displayed. To view details of a specific API, click the link in the title.

Back to top

How do I modify an API associated with an organization on the API platform?

If you're a Business Admin, you have full rights to add, view, edit, or delete APIs that are set up for your organization.

To modify an API associated with an organization:
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click APIs. All APIs associated with the organization are displayed.
  4. Find the API you want to edit, and then click the title to view the API summary page.
  5. In the left menu, click Details to access the API Designer summary page.
  6. Edit the API in the same way as you would at the root organization level. For detailed instructions, see Add or Modify an API using API Designer.

Back to top

How do I move an API from one organization to another?

You can move an API that's in the context of one of your organizations into another organization, as long as you are a Business Admin for both organizations. For example, you might have a billing department and a payments department, and create the billing API in the context of the payments department by mistake. You can easily move it. Follow the steps below.

Note: When you move an API, all versions of the API are moved.

To move an API from one business organization to another
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find the organization that the API currently exists under, and then click the title to view the Details page for the organization.
  3. On the left navigation bar, choose APIs. All APIs associated with the organization are displayed.
  4. Find the API that you want to move, and then click the title to view the API Overview page.
  5. On the left navigation bar, click Details to view the API Details page.
  6. Click Edit.
  7. On the right, in the Parent Organization Name field, start typing the name of the organization you want to move it to. After the first three characters, the platform displays a list of matching organizations for you to choose from.
  8. Click the entry for the new organization so that the full name is displayed in the field.
  9. Click Save. The API is moved to the new organization.

Back to top

How do I delete an API associated with an organization on the API platform?

If you're a Business Admin, you have full rights to add, view, edit, or delete APIs that are set up for your organization.

If you're deleting an API, you should first make sure there are no active app contracts associated with the API.

Note: If there are multiple versions for the API, you must delete each version. When you delete the final version, the API is deleted.

To delete an API associated with an organization:
  1. In the Developer Portal, go to the Organizations List (see To access the Organizations List).
  2. Find your organization on the list, and then click the title to view the Details page for the organization.
  3. In the left menu, click APIs. All APIs associated with the organization are displayed.
  4. Find the API on the list, and click the link in the title.
  5. In the left menu, click Details to access the API Designer summary page.
  6. Click Delete Version. At the confirmation message, click OK. The API version is deleted. When the last version is deleted, the API is deleted.

Back to top

What roles can manage APIs for my business organization on the platform?

The Business Admin has full responsibility for all resources, such as apps and APIs, created at the organization level.

A user who has been assigned the API Administrator role by a Business Admin, in the context of a specific business organization, has full rights to view, add, modify, or delete APIs for the organization, but cannot view or manage API Admins (see What are the default roles for the API platform?). Only the user who created the business API, or was invited to the API Admin group for the business API, can manage API Admins for an API in the context of a business organization. See What API management capabilities are available to the API Admin in the platform?

App developers on the platform can request access to APIs within a business organization if they have permission to do so.

Back to top