This tutorial explains step by step how to create all necessary elements of API Management to be able to manage a private API. Private APIs are APIs that are only accessible for known consumers (clients).

ACME Corp. uses Scheer PAS API Management to provide customers with access to the ACME APIs. For example, ACME Corp. is running the test service RESTAPI_Echo_Example which implements a very basic REST service that is perfect for testing. Now David Stringer of ACME Corp. wants to enable the developers of customer Spring Corp. to use this service. So David is going to setup private API access to the service RESTAPI_Echo_Example.

You are going to help him with that task.

During this tutorial you will build up the following: Organization STRINGER containing the PrivateEchoAPI, which will be consumed by client Spring Corp. via plan Gold which contains the Rate Limiting Policy.


During this tutorial you will learn

  • how to create an organization

  • how to create a plan

  • how to import the API of an xUML service from the PAS Administration to API Management

  • how to create a client

  • how to add a contract
  • how to apply policies to plans and APIs
  • how to restrict the visibility of an API
  • how to test API access in API Management
  • how to consume a private API via the API Developer Portal

A Short Introduction to API Management Concepts

Prerequisites

How to Deploy the Example