Versions Compared

Old Version 36

changes.mady.by.user Annegret Bernhardt

Saved on

compared with

New Version Current

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: prerequisites_api_tutorials moved to _academy_excerpts

api_management_concepts

Info
titleUsed on:


Multiexcerpt
MultiExcerptNameapi_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 into managed APIs by attaching policies to them.

Every managed API can be published aspublic API or private API:

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.

 

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

prerequisites_api_tutorials

Info
titleUsed on:
Multiexcerpt
MultiExcerptNameprerequisites_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.

prerequisites_api_tutorials_deployment

Info
titleUsed on:


Multiexcerpt
MultiExcerptNameprerequisites_api_tutorials_deployment

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

To access the deployment wizard, open the Administration.

Info

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.

Note

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.





Panel
titleOn this Page:
Table of Contents