Important Note

This space contains files and text snippets that are used throughout the Scheer PAS documentation.
This content is not meant to be read independently from the rest of the documentation.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

ChapterNameExcerptUsage
API Management Tutorialsapi_management_concepts

The main elements of API Management are Clients, Plans and APIs. All of them can contain Policy definitions. To be used, they need to be grouped by an Organization and related by a Contract.

All of these elements need to be present in your API Management to make a private API accessible:

  • The client is the consumer of the API.

  • A plan is a set of policies that defines the level of service API Management provides for an API.

  • The API itself is a representation of a real backend API (e.g. an xUML service).

  • Policies are rules or units of work applied when the API is accessed.

APIs are created within API Management. They are published to the API Developer Portal from where consumers of the API have access to them.

 

For more information on the concepts of API Management, refer to The Concepts of API Management.

API Management Tutorialsprerequisites_api_tutorials

The following elements must be present or installed in order to be able to go through the step-by-step tutorials:

  • You need an up-and-running installation of Scheer PAS and access to the components API Management and Administration.
  • The RESTAPI_Echo_Example must be deployed in the administration component. You can download the repository here to deploy it.

How to Deploy the Example

Deploy the service via the deployment wizard within the PAS Administration.

To access the deployment wizard, open the Administration.

Your user needs the profile xuml_container_admin to use the deployment wizard and to manage xUML services in the Administration.

Use in the navigation bar to open the deployment wizard.

The wizard opens in a separate pop-up window.

As soon as you have selected the .rep file of the service, the wizard guides you through the necessary steps to deploy the xUML service.

In step 2 of the deployment wizard, please adjust the service name so that it matches your user, e.g. restapi-echo-example-stringer.

Refer to Administration Guide > Working With the Deployment Wizard for detailed step-by-step instructions.

  • No labels