This tutorial explains step by step how to create all necessary elements of API Management to be able to manage a public API. Public APIs are APIs that are accessible by any consumer. However, Scheer PASAPI Management still allows to restrict access to public APIs by adding rules to them, the so-called policies. You can also restrict the visibility of each API to ensure that only a defined group of persons can find it.
Follow Our Example User Story
ACME Corp.uses Scheer PASAPI Managementto 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 give developers in general the opportunity to use this service. So David is going to setup public API access to the service RESTAPI_Echo_Example.
You are going to help him with that task.
During this tutorial you will learn
how to create an organization
how to import the API of an xUML service from the PAS Administration to API Management
how to add policies to the API
how to make the API available for all visitors of the API Developer Portal
how to test API access
how to consume a public API via the API Developer Portal
All content in a lighter font color refers to the story of the tutorial.
A Short Introduction to API Management Concepts
The main elements of API Management are grouped within an Organization, which is the "container" for all other elements such as Clients, Plans and APIs. APIs represent real backend APIs (Application Programming Interfaces). API Management provides a way to turn unmanaged (raw) back-end APIs intomanagedAPIs by attaching policies to them.
Every managed API can be published aspublicAPI or privateAPI:
Public APIs...
Private APIs...
... reside in an organization.
... can contain policy definitions.
... are accessible to everyone.
... reside in an organization.
... can contain policy definitions.
... can only consumed by a client via a contract and a plan.
Plans and clients can also contain policies.
Policies are rules or units of work applied when the API is accessed.
APIs are created within API Management. They are provided via the API Developer Portal from where consumers of the API have access to them.