Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: link to prerequisites_api_tutorials changed because excerpt moved to another page

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).

Panel
borderColor#bab6b9
titleFollow Our Example User Story

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.


Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNamenote_doc_story
PageWithExcerptINTERNAL:_academy_excerpts

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameuse_your_own_name
PageWithExcerptINTERNAL:_academy_excerpts

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

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameapi_management_concepts
PageWithExcerptINTERNAL:_academy_excerpts_big

Prerequisites

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameprerequisites_api_tutorials
PageWithExcerptINTERNAL:_academy_excerpts_big

How to Deploy the Example

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameprerequisites_api_tutorials_deployment
PageWithExcerptINTERNAL:_academy_excerpts_big


Panel

Start the Tutorial


Panel
titleOn this Page:

Table of Contents


Panel
titleRelated Pages:


Panel
titleRelated Documentation:





...