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.
- Created by Kirstin Seidel-Gebert, last modified by Annegret Bernhardt on Jan 11, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 80 Next »
Some API Management excerpts are saved within the documenation, see API Management excerpts managed directly in the documentation for an overview.
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 ...
Group | Name | Excerpt | Usage |
---|---|---|---|
Administration | manage_users | API Management uses the Keycloak application to manage its users. Keycloak is an identity and access management software that can manage users for multiple applications. Data for each application is stored in so called "realms":
Thus, you need to have to separate admin accounts: one for Keycloak, and one for API Management. | |
Administration | test_gateway_nok | If the configuration is invalid, an error message will be shown including further information about the error itself: | |
Administration | test_gateway_ok | If the gateway configuration is correct, you will get a success message: | |
APIs | retired Example in swagger.yaml schemes: - https security: - X-API-Key: [] securityDefinitions: X-API-Key: description: Authenticate using pre-acquired API key in: header name: X-API-Key type: apiKey Note: Depending on the used policies, further entries in the YAML or JSON file may be necessary. | ||
APIs | |||
Clients | api_registered_client | Before the client is registered with the runtime gateway, it is not possible to make requests to backend APIs on behalf of that client. | |
Clients | swagger_ui | For more information about the functions of the Swagger UI, go to the Swagger homepage. | |
General Notes, Infos, Tips | api_displayed_when_published | This tab is only visible for published APIs. |
|
General Notes, Infos, Tips | use_breadcrump | Use the breadcrumb menu at the top of the page for guidance. |
|
General Notes, Infos, Tips | api_displayed_when_registered | This tab is only visible for registered clients. | |
General Notes, Infos, Tips | api_link_to_policy_page | On page Policies you can find an overview of the standard policies supplied with Scheer PAS API Management. Page Assigning Policies shows how to configure a policy. | |
General Notes, Infos, Tips | api_my_all_hint | If you want to edit API Management elements, you need to access them via the My... menu items (see "My" API Management items). | |
General Notes, Infos, Tips | api_save_when_finished | Do not forget to click the Save button when you have finished. |
|
General Notes, Infos, Tips | api_version_number_note | You can enter numbers and text in the Version field which allows the use of version numbers (e.g. 1.0, 2.1 ...) as well as version descriptions (e.g. Gold, Super etc.). | |
General Notes, Infos, Tips | api_work_with_items | Click | |
General Notes, Infos, Tips | note_read_confirmation_dialog | Please read the confirmation dialog carefully. | |
Kibana | kibana | Kibana is an open source analytics and visualization tool designed to work with Elasticsearch. With Kibana you can search, view, and interact with data stored in Elasticsearch indices. You can perform advanced data analysis and visualize your data in a variety of charts, tables, and maps. | |
Organizations | api_org_creation | Only users with role Administrator can create new organizations. | |
Plans | locked_plans | Once a plan is locked, it cannot be revised anymore. However, you can still create a new version of this plan. | |
Policies | api_behind_proxy | Please disable the TLS check if you are using Scheer PAS 21.1, because this version is running behind a proxy server. | |
Policies | api_blacklist_whitelist | An IP Blacklist policy overrides an IP Whitelist policy. | |
Policies | api_enable_option | It is strongly recommended to enable this option. | |
Policies | api_move_policies | The order of the policies is important. The order in which the policies appear in the user interface determines the order they will be applied at runtime. You can drag a policy up and down the list to change the order: | |
Policies | api_no_ipv6 | The use of IPv6 is neither possible in the blacklist nor in the whitelist policy. |
|
Policies | cors_policy_chain | API Management sets the CORS headers in the following order:
| |
Policies | proxy_x_real | In the default setup the gateway runs behind a proxy. In the default scenario there is no need to add the header X-Real-IP in the custom header field IP Address HTTP Header. | |
Step by Step Guides | api_definition_details | moved to academy_excerpts, delete after publication of version 21.2.2_api Detailed information about the necessary settings in the definition file can be found on page API Settings. | |
Step by Step Guides | goto_chapter_apis | moved to academy_excerpts, delete after publication of version 21.2.2_api Go to APIs to learn more about the details of an API and its configuration options. | |
Step by Step Guides | goto_chapter_organizations | moved to academy_excerpts, delete after publication of version 21.2.2_api Go to Organizations to learn more about the details of an organization and its configuration options. | |
Step by Step Guides | step_by_step_policies | moved to academy_excerpts, delete after publication of version 21.2.2_api On page Policies you can find an overview of all policies provided in API Management. Each policy and its configuration options are explained on dedicated pages. | |
Support | support_overview |
| |
Terms & Definitions | api_contracts_and_keys | API Contracts and API KeysOnly public APIs can be accessed by any consumer. The only way for a client to consume a private API is by using an API contract. An API contract is a link between a client and an API through a plan offered by that API. API contracts can only be created between clients and published APIs which are offered through at least one plan. An API contract cannot be created between a client and a public API. When an API contract is created, the system generates a unique API Key. This key is unique per client and the same for all contracts of this client. All requests made to the API by a client through the gateway must include this API Key. The API Key is used to create the runtime policy chain from the policies configured on the API, plan and client. You can forward the X-API-Key to the service using the API Key policy. However, you cannot define your own value for the X-API-Key, since the gateway uses the key to identify the clients. | |
Terms & Definitions | definition_api | APIs in API Management represent real back-end APIs (Application Programming Interfaces). An API is also known as a service, meaning anything that can be invoked remotely by some sort of client. 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 as Public API or Private API or both:
In API Management, users can create new APIs manually or easily import them from the API Catalog. | |
Terms & Definitions | definition_client | The client is the consumer of the API:
| |
Terms & Definitions | definition_contract | A contract relates a client to an API, using a plan. | |
Terms & Definitions | definition_organization | Almost everything in the API Management data model exists in the context of an organization:
| |
Terms & Definitions | definition_plan | A plan is a set of policies that defines the level of service API Management provides for an API.
| |
Terms & Definitions | definition_policy | Policies are at the lowest level of the data model, but they are the most important concept: A policy is a rule or a set of rules API Management uses to manage access to your APIs.
| |
Tips | click_to_see_gif | moved to page _general_excerpts - delete after publication of doc-version 21.2 Click the image to see an animated version. | |
Tips | click_to_see_gif_above | moved to page _general_excerpts - delete after publication of doc-version 21.2 Click the image above to see an animated version. |
API Management excerpts managed directly in the documentation
Chapter | Excerpt Name | Page of the Original | (Re-)Usage |
---|---|---|---|
Administration | data_export | ||
Administration | backup | ||
Administration | data_import | ||
Administration | restore | ||
Administration | keycloak_login |
| |
Policies | definition | ||
Policies | info_post_requests |
| |
Metrics | api_metrics | ||
Metrics | client_metrics | Metrics |
Some API Management excerpts are saved within the documenation, see API Management excerpts managed directly in the documentation for an overview.
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 ...
Group | Name | Excerpt | Usage |
---|---|---|---|
Administration | manage_users | API Management uses the Keycloak application to manage its users. Keycloak is an identity and access management software that can manage users for multiple applications. Data for each application is stored in so called "realms":
Thus, you need to have to separate admin accounts: one for Keycloak, and one for API Management. | |
Administration | test_gateway_nok | If the configuration is invalid, an error message will be shown including further information about the error itself: | |
Administration | test_gateway_ok | If the gateway configuration is correct, you will get a success message: | |
APIs | retired Example in swagger.yaml schemes: - https security: - X-API-Key: [] securityDefinitions: X-API-Key: description: Authenticate using pre-acquired API key in: header name: X-API-Key type: apiKey Note: Depending on the used policies, further entries in the YAML or JSON file may be necessary. | ||
APIs | |||
Clients | api_registered_client | Before the client is registered with the runtime gateway, it is not possible to make requests to backend APIs on behalf of that client. | |
Clients | swagger_ui | For more information about the functions of the Swagger UI, go to the Swagger homepage. | |
General Notes, Infos, Tips | api_displayed_when_published | This tab is only visible for published APIs. |
|
General Notes, Infos, Tips | api_displayed_when_registered | This tab is only visible for registered clients. | |
General Notes, Infos, Tips | api_link_to_policy_page | On page Policies you can find an overview of the standard policies supplied with Scheer PAS API Management. Page Assigning Policies shows how to configure a policy. | |
General Notes, Infos, Tips | api_my_all_hint | If you want to edit API Management elements, you need to access them via the My... menu items (see "My" API Management items). | |
General Notes, Infos, Tips | api_save_when_finished | Do not forget to click the Save button when you have finished. |
|
General Notes, Infos, Tips | api_version_number_note | You can enter numbers and text in the Version field which allows the use of version numbers (e.g. 1.0, 2.1 ...) as well as version descriptions (e.g. Gold, Super etc.). | |
General Notes, Infos, Tips | api_work_with_items | Click | |
General Notes, Infos, Tips | note_read_confirmation_dialog | Please read the confirmation dialog carefully. | |
Kibana | kibana | Kibana is an open source analytics and visualization tool designed to work with Elasticsearch. With Kibana you can search, view, and interact with data stored in Elasticsearch indices. You can perform advanced data analysis and visualize your data in a variety of charts, tables, and maps. | |
Organizations | api_org_creation | Only users with role Administrator can create new organizations. | |
Plans | locked_plans | Once a plan is locked, it cannot be revised anymore. However, you can still create a new version of this plan. | |
Policies | api_behind_proxy | Please disable the TLS check if you are using Scheer PAS 21.1, because this version is running behind a proxy server. | |
Policies | api_blacklist_whitelist | An IP Blacklist policy overrides an IP Whitelist policy. | |
Policies | api_enable_option | It is strongly recommended to enable this option. | |
Policies | api_move_policies | The order of the policies is important. The order in which the policies appear in the user interface determines the order they will be applied at runtime. You can drag a policy up and down the list to change the order: | |
Policies | api_no_ipv6 | The use of IPv6 is neither possible in the blacklist nor in the whitelist policy. |
|
Policies | cors_policy_chain | API Management sets the CORS headers in the following order:
| |
Policies | proxy_x_real | In the default setup the gateway runs behind a proxy. In the default scenario there is no need to add the header X-Real-IP in the custom header field IP Address HTTP Header. | |
Step by Step Guides | api_definition_details | moved to academy_excerpts, delete after publication of version 21.2.2_api Detailed information about the necessary settings in the definition file can be found on page API Settings. | |
Step by Step Guides | goto_chapter_apis | moved to academy_excerpts, delete after publication of version 21.2.2_api Go to APIs to learn more about the details of an API and its configuration options. | |
Step by Step Guides | goto_chapter_organizations | moved to academy_excerpts, delete after publication of version 21.2.2_api Go to Organizations to learn more about the details of an organization and its configuration options. | |
Step by Step Guides | step_by_step_policies | moved to academy_excerpts, delete after publication of version 21.2.2_api On page Policies you can find an overview of all policies provided in API Management. Each policy and its configuration options are explained on dedicated pages. | |
Support | support_overview |
| |
Terms & Definitions | api_contracts_and_keys | API Contracts and API KeysOnly public APIs can be accessed by any consumer. The only way for a client to consume a private API is by using an API contract. An API contract is a link between a client and an API through a plan offered by that API. API contracts can only be created between clients and published APIs which are offered through at least one plan. An API contract cannot be created between a client and a public API. When an API contract is created, the system generates a unique API Key. This key is unique per client and the same for all contracts of this client. All requests made to the API by a client through the gateway must include this API Key. The API Key is used to create the runtime policy chain from the policies configured on the API, plan and client. You can forward the X-API-Key to the service using the API Key policy. However, you cannot define your own value for the X-API-Key, since the gateway uses the key to identify the clients. | |
Terms & Definitions | definition_api | APIs in API Management represent real back-end APIs (Application Programming Interfaces). An API is also known as a service, meaning anything that can be invoked remotely by some sort of client. 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 as Public API or Private API or both:
In API Management, users can create new APIs manually or easily import them from the API Catalog. | |
Terms & Definitions | definition_client | The client is the consumer of the API:
| |
Terms & Definitions | definition_contract | A contract relates a client to an API, using a plan. | |
Terms & Definitions | definition_organization | Almost everything in the API Management data model exists in the context of an organization:
| |
Terms & Definitions | definition_plan | A plan is a set of policies that defines the level of service API Management provides for an API.
| |
Terms & Definitions | definition_policy | Policies are at the lowest level of the data model, but they are the most important concept: A policy is a rule or a set of rules API Management uses to manage access to your APIs.
| |
Tips | click_to_see_gif | moved to page _general_excerpts - delete after publication of doc-version 21.2 Click the image to see an animated version. | |
Tips | click_to_see_gif_above | moved to page _general_excerpts - delete after publication of doc-version 21.2 Click the image above to see an animated version. |
API Management excerpts managed directly in the documentation
Chapter | Excerpt Name | Page of the Original | (Re-)Usage |
---|---|---|---|
Administration | data_export | ||
Administration | backup | ||
Administration | data_import | ||
Administration | restore | ||
Administration | keycloak_login |
| |
Policies | definition | ||
Policies | info_post_requests |
| |
Metrics | api_metrics | ||
Metrics | client_metrics | Metrics |
- No labels