--- parser: v2 author_name: Kasturi Kabiraj author_profile: https://github.com/Kakabira auto_validation: true time: 15 tags: [ tutorial>beginner, software-product>sap-api-management] primary_tag: software-product>sap-api-management slug: api-mgmt-isuite-initial-setup canonical_url: https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup --- # Set Up API Management from SAP Integration Suite Use this tutorial to provision the API Management capability from SAP Integration Suite. ## Prerequisites - You already have a subaccount and have enable the Cloud Foundry environment in this subaccount. For more information, see [Create a Subaccount](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/05280a123d3044ae97457a25b3013918.html?q=entitlements). - An Integration Suite entitlement has been created for your subaccount. For more information, see [Configure Entitlements](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/37f8871865114f44aebee3db6ac64b72.html?q=create%20entitlements). ## You will learn - How to provision API Management capability from Integration Suite. - Access API Management features and resources available on Integration Suite. ## Intro To set up the API Management capability from Integration Suite, you should first have an Integration Suite subscription. >**IMPORTANT** Ensure that you don't have an instance of starter plan created in the same subaccount, where you plan to create an Integration Suite subscription. Also, note that API Management capabilities from Integration Suite and API Management subscriptions using the standalone tile cannot coexist in the same subaccount. --- ### Subscribe to Integration Suite 1. Log on to SAP BTP Cockpit and navigate to your subaccount. 2. In the navigation area of the subaccount, choose **Services** > **Service Marketplace**. Search for **Integration Suite** and choose **Create**. ![Integration Suite Tile](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/Isuite-tile.png) 3. On the **New Instances and Subscriptions** dialog, select the **Service** and the **Plan** and choose **Create**. Wait for the subscription to complete successfully. ![Create Integration Suite Subscription](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/Isuite-create.png) 4. Choose **View Subscription** on the **Creation in Progress** dialog. ![Creation of Integration Suite Subscription in Progress](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/View-Subscription.png) Check the status of the submission in subscriptions section on the **Instances and Subscriptions** page. If the subscription is successful you'll notice the status of the **Integration Suite** shown as **Subscribed**. To access Integration Suite, you must first assign the "Integration Provisioner" role to yourself. >**IMPORTANT** If you choose **Go to Application** without assigning the **Integration Provisioner** role, an application authentication error appears. If the error persists after assigning the role, clear your web browser cache and log out of the application and log in again. ### Assign the Integration Provisioner Role 1. On the navigation pane, choose **Security** > **Users**. ![Assign Role](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/User-Role.png) 2. Select the user to whom you want to assign the role, and under **Role Collections** section, choose **Assign Role Collection**. ![Assign Role Collection](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/Assign-Role-Collection.png) 3. In the resulting dialog box, select the **Integration_Provisioner** role and choose **Assign Role Collection**. ![Assign Integration Provisioner Role](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/integration-provisioner-role.png) ### Get Directed to Integration Suite Homepage 1. Once the **Integration Provisioner** role is assigned, choose **Instances and Subscriptions** on the left navigation pane. 2. Under **Subscriptions** look for **Integration Suite**, and choose **Go To Application**. ![Getting directed to Integration Suite Homepage](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/go-to-application.png) ### Activate API Management Capability 1. On the Integration Suite home page, under **Capabilities**, choose **Add Capabilities**. ![Add Capabilities](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/add-capabilities.png) 2. To design, develop, publish, and oversee APIs in a secure and scalable environment, choose **Manage APIs** and choose **Next** on the **Activate Capabilities** dialog. ![Add API Management Capability](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/design-develop-manage.png) 3. To discover, consume and monitor APIs from a centralized API catalogue, select the checkbox **Developer Hub**. Once you enable Developer Hub, you will get an option to enable **API Composition**. If you want to expose all your business data in the form of a single semantically connected data graph, select the checkbox for **API Composition**, and choose **Next**. ![Activate Developer Hub](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/activate-abhe-api-composition.png) 4. Choose **Activate** on the **Activate Capabilities** dialog. ![API Portal and Developer Hub is Active ](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/activate-devhub-api-composition.png) 5. On the resulting screen, choose **OK** once the status changes from **In Progress** to **Active**. ![API Portal and Developer Hub is Active ](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/Isuite-activated_apim-api-composition.png) 6. Go to the **SAP BTP Cockpit**, choose **Security** > **Users** and select the user to whom you want to assign the role. Under **Role Collections** section, choose **Assign Role Collection**. In the resulting dialog box, choose the following roles and choose **Assign Role Collection**: - **APIManagement.Selfservice.Administrator** - This role is required to configure API Management service in SAP Integration Suite. - **AuthGroup.SelfService.Admin** - This role is required during the onboarding of Developer Hub and to get access to it. - **Graph.KeyUser** - This role is required to create and activate business data graphs for a landscape. - **GraphNavigator.Viewer** - This role is required to explore business data graphs in **API Composition Navigator**. 7. Refresh the SAP Integration Suite page. If you don't see the **APIs** option under the **Settings** tab, log out of the Integration Suite page and log in again. ### Configure the API Management Service 1. On the **Integration Suite** home page, choose **Settings** > **Runtimes** from the left navigation pane. ![Setting Up API Management Service](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/settings-api.png) 2. On the **Configure the API Management Service** page, configure the following and choose **Activate**: - Select the Account type: - Select **Non-Production** account type for non-business critical activities. - Select **Production** account type for business-critical usage. - In the **Virtual Host** section, enter the **Host Alias**. - Provide an email ID in **Notification Contact** to receive updates. ![Configure the API Management Service](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/config-apim-service.png) 3. In the **Set-up Confirmation** window, review the provided details and choose **Confirm** to start the onboarding process. ![Configure the API Management Service](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/config-apim-service-confirm.png) You're redirected to a progress window, which states **API Management Service Setup In Progress**. The **Configuration** process is triggered, where the necessary resources are provisioned for you. It's followed by **Testing the Setup**, where a simple API Proxy is deployed and invoked to check that everything is set up properly. When the processes complete, the indicators turn green to indicate that the processes are successful. A **Release Notification** email is sent out to the email ID, which you provided earlier in the process in the **Configure the API Management Service** screen. This e-mail contains details of the newly set up API Management service on your account. ![Completion of API Management Onboarding](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/apim-setup-complete.png) 4. Log out of the **Integration Suite** and login again. ![Welcome to API Management Service](https://raw.githubusercontent.com/sap-tutorials/btp-adai/main/tutorials/api-mgmt-isuite-initial-setup/welcome-msg.png) You can now create APIs, build API proxies as a service provider, or use APIs and other convenient services. ---