| administration_service_running
|
Multiexcerpt |
---|
MultiExcerptName | administration_service_running |
---|
| As described in the prerequisites of the tutorial, you need to have access to the PAS Administration, and the RESTAPI_Echo_Example must be deployed and running in the Administration. To import the API, open your service within the PAS Administration and go to tab Details. |
| |
API Tutorials | api_definition_details | | |
API Tutorials | email_notifications
|
Multiexcerpt |
---|
MultiExcerptName | email_notifications |
---|
|
Info |
---|
If the email notification feature is enabled on your system, the requester and the approver will also receive emails for each step of the approval process. |
|
| |
API Tutorials | good_to_know_api |
Multiexcerpt |
---|
MultiExcerptName | good_to_know_api |
---|
|
Info |
---|
icon | false |
---|
title | Good to Know |
---|
|
Expand |
---|
| APIs represent real backend APIs (Application Programming Interfaces). An API is also known as a service, which offers a HTTP, REST or SOAP interface that can be invoked remotely by a client.
Scheer PAS API Management provides a way to turn unmanaged (raw) back-end APIs into managed APIs by attaching policies to them. Any policies configured on an API will be applied at runtime, regardless of the client and API contract.
An API has to be fully configured, including policies and implementation (and in case of public APIs including plans) to be published. If the API has been published to the gateway it can be consumed - in case of private APIs by clients. Refer to API Management Guide > APIs for more details. |
|
|
| |
API Tutorials | good_to_know_developer_portal |
Multiexcerpt |
---|
MultiExcerptName | good_to_know_developer_portal |
---|
|
Info |
---|
icon | false |
---|
title | Good to Know |
---|
|
Expand |
---|
title | What is the API Developer Portal? |
---|
| The API Developer Portal allows you to grant customer developers access to your APIs. In the Developer Portal, developers can sign up for APIs, access them, and try out APIs that you have enabled for them. The portal is designed to keep the discovery and use of APIs simple for the target group. Refer to API Management Guide > Developer Portal for more details. |
|
|
| |
API Tutorials | |
Multiexcerpt |
---|
MultiExcerptName | good_to_know_policy |
---|
|
Info |
---|
icon | false |
---|
title | Good to Know |
---|
|
Expand |
---|
| A policy is a rule or a set of rules API Management uses to manage access to your APIs. Policies are applied to all API requests and represent a unit of work applied at runtime to the request by API Management. Policies are applied through a policy chain: when a request to an API is made, API Management creates a chain of policies to be applied to that request. The policy chain is applied to the request in a fixed order: Client policies are applied first, then policies added to plans, and finally policies added to the API itself. Refer to API Management Guide > Policies for more details. |
|
|
| |
API Tutorials | good_to_know_visibility
|
Multiexcerpt |
---|
MultiExcerptName | good_to_know_visibility |
---|
|
Info |
---|
icon | false |
---|
title | Good to Know |
---|
|
Expand |
---|
title | What is the visibility concept all about? |
---|
| The visibility concept of API Management defines which user groups can find the APIs in the Developer Portal. The visibility resides on top of the permission system as another security layer. Visibilities are applicable to public APIs and plans for private APIs. Three different visibilities are available: Organization members (default), API Management users, and API Developer Portal users. Refer to API Management Guide > The Concepts of API Management for more details. |
|
|
| |
API Tutorials | goto_chapter_apis |
Multiexcerpt |
---|
MultiExcerptName | goto_chapter_apis |
---|
| Refer to API Management Guide > APIs to learn more about the details of an API and its configuration options. |
| |
API Tutorials | goto_chapter_organizations |
Multiexcerpt |
---|
MultiExcerptName | goto_chapter_organizations |
---|
| Refer to API Management Guide > Organizations to learn more about the details of an organization and its configuration options. |
| |
API Tutorials | import_api
|
Multiexcerpt |
---|
MultiExcerptName | import_api |
---|
| Tab Endpoints shows all service endpoints, that have automatically been created during deployment. Select the endpoint with your service name EchoAPI and type rest, and click Import API Image Added to start the import to API Management. |
| |
API Tutorials | import_api_finished |
Multiexcerpt |
---|
MultiExcerptName | import_api_finished |
---|
| The import is finished and you are redirected to the details page of your new API. Now you can start configuring your API. |
| |
API Tutorials | import_wizard_organization
|
Multiexcerpt |
---|
MultiExcerptName | import_wizard_organization |
---|
| The creation wizard will open and you can choose your organization. Click Next to continue. |
| |
API Tutorials | import_wizard_summary |
Multiexcerpt |
---|
MultiExcerptName | import_wizard_summary |
---|
| The Summary displays all details of the API. The settings of the API such as Endpoint, Definition URL, Definition Type and API Type will be filled with the corresponding information. Refer to API Management Guide > API Settings for details about the settings of an API. Click Create API to finish the import. |
| |
API Tutorials | info_tutorial_3
|
Multiexcerpt |
---|
MultiExcerptName | info_tutorial_3 |
---|
|
Info |
---|
As users with different authorizations are required for the approval process, this is not a "do it yourself" tutorial. |
|
| |
API Tutorials | open_get_method
|
Multiexcerpt |
---|
MultiExcerptName | open_get_method |
---|
| Open the GET /HelloWorld method. Click Execute to test the GET request. |
| |
API Tutorials | open_test_ui
|
Multiexcerpt |
---|
MultiExcerptName | open_test_ui |
---|
| The test UI opens in a new browser tab. Refer to the Swagger homepage for more information about the functions of the Swagger UI. At the top of the page, the Base URL and the link to the API definition are displayed. Expand the displayed operations to start testing. |
| |
API Tutorials | prerequisites_api_tutorials |
Multiexcerpt |
---|
MultiExcerptName | prerequisites_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.
|
| |
API Tutorials | step_by_step_policies |
Multiexcerpt |
---|
MultiExcerptName | step_by_step_policies |
---|
| For an overview on all policies provided in API Management refer to API Management Guide > Policies. Each policy and its configuration options are explained on dedicated pages. |
| |
API Tutorials | use_your_own_name
|
Multiexcerpt |
---|
MultiExcerptName | use_your_own_name |
---|
|
Note |
---|
Please make sure that the name of the created elements such as organizations, APIs, clients etc. is unique. You can use your own name as pre- or suffix (PublicEchoAPI_David...). |
|
| |
API Tutorials | why_dev_portal |
Multiexcerpt |
---|
MultiExcerptName | why_dev_portal |
---|
|
Info |
---|
title | Why a Developer Portal? |
---|
| Why does Scheer PAS API Management also provide a separate Developer Portal? The portal allows you to grant your customers' developers access to your APIs. Developers can list and try out APIs that you have enabled for them. Using the Developer Portal has several advantages: - Security: Each developer gets his own secure login to the portal. It is a secure way to provide API keys to customers instead of sending the keys by email, for example.
- Service: Using the portal allows your customers' developers to test the available APIs.
- Life Cycle Management: Users of the portal can view all versions of the APIs. They get also an overview on the status of each API, if it is available, in development or retired, and can also access its documentation. Refer to
|
|
|