Chapter | Name | Excerpt | Usage |
---|
APIs | info_open_api_documentation
|
Multiexcerpt |
---|
MultiExcerptName | info_open_api_documentation |
---|
|
Info |
---|
Adding or removing policies does not enrich the Open API documentation. You need to adjust your documentation manually. For more information on REST documentation and how to add documentation to xUML services, refer to Bridge Guide > Documenting a REST Service. |
|
| |
APIs | info_testing_apis
|
Multiexcerpt |
---|
MultiExcerptName | info_testing_apis |
---|
|
Info |
---|
Testing of API configurations is only possible with REST APIs that are coming with an OpenAPI Specification. |
|
| |
APIs | setting_validity_api
|
Multiexcerpt |
---|
MultiExcerptName | setting_validity_api |
---|
| This setting is valid for all versions of the API. |
| |
Clients | setting_validity_client |
Multiexcerpt |
---|
MultiExcerptName | setting_validity_client |
---|
| This setting is valid for all versions of the client. |
| |
Developer Portal | access_documentation_and_definiton
|
Multiexcerpt |
---|
MultiExcerptName | access_documentation_and_definiton |
---|
| You can also access the API Documentation and Download the API definition file here. |
| |
Developer Portal | api_documentation
|
Multiexcerpt |
---|
MultiExcerptName | api_documentation |
---|
| Click API Documentation to access the Swagger UI where you can test the API (refer to Testing APIs for further information). |
| |
Developer Portal | confirm_delete
|
Multiexcerpt |
---|
MultiExcerptName | confirm_delete |
---|
| For security reasons, you need to confirm the deletion. |
| |
Developer Portal | display_open_api_definition
|
Multiexcerpt |
---|
MultiExcerptName | display_open_api_definition |
---|
| Displays the Open API definition (Swagger) and allows for making test calls if the API is available. |
| |
Developer Portal | download_open_api_definition |
Multiexcerpt |
---|
MultiExcerptName | download_open_api_definition |
---|
| Downloads the API definition file. |
| |
Developer Portal | latest_api_version
|
Multiexcerpt |
---|
MultiExcerptName | latest_api_version |
---|
| If more than one version of the API is available, the latest version will be displayed on top. To see the details of earlier versions, expand the labels below the open details page. |
| |
Developer Portal | portal_copy_to_clipboard
|
Multiexcerpt |
---|
MultiExcerptName | portal_copy_to_clipboard |
---|
| Click Copy to copy the key to the clipboard. |
| |
Developer Portal | sign_up_client_created |
Multiexcerpt |
---|
MultiExcerptName | sign_up_client_created |
---|
| After a successful creation, your client is displayed in the box below. Click Next to continue. |
| |
Developer Portal | sign_up_create_client
|
Multiexcerpt |
---|
MultiExcerptName | sign_up_create_client |
---|
| Now follow the wizard through some simple steps: - Create a new client: Enter the name of your client in field Search or create.
Click Create. |
| |
Developer Portal | sign_up_multiple_organizations
|
Multiexcerpt |
---|
MultiExcerptName | sign_up_multiple_organizations |
---|
| If your user has permission to use or create clients in various organizations, a different view will be displayed:
- Field Organization is a drop-down and you can select the organization you want to create a new client in.
- Below, the list of available clients for your user is displayed and you can select one directly.
- If a client has more then one version, you can also select the client version from a drop-down list.
Click Next to continue. |
| |
Developer Portal | sign_up_my_clients_tab |
Multiexcerpt |
---|
MultiExcerptName | sign_up_my_clients_tab |
---|
| Tab My Clients displays an overview of your clients and their contracts. Your new client is displayed and labeled as Awaiting Approval. Refer to Handling Approval Requests for detailed information about the approval process in API Management. |
| |
Developer Portal | sign_up_request_approved
|
Multiexcerpt |
---|
MultiExcerptName | sign_up_request_approved |
---|
| As soon as an administrator approved your request, you will get a notification. Now you can start using the API. |
| |
Developer Portal | sign_up_success |
Multiexcerpt |
---|
MultiExcerptName | sign_up_success |
---|
| A success message is displayed in the Developer Portal. If approval is required for the API you subscribed to, you now have to wait for the approval. If approval is not necessary to use the API, you have now access to it. If you want to check your newly created client, switch to the My Clients tab. |
| |
Developer Portal | sign_up_summary |
Multiexcerpt |
---|
MultiExcerptName | sign_up_summary |
---|
| In step 2, the summary displays the API-related information. Click Confirm to send your request. Info |
---|
API Key and Endpoint will be provided to you after your request is approved. |
|
| |
General | adding_versions | | |
General | api_learn_more
|
Multiexcerpt |
---|
MultiExcerptName | api_learn_more |
---|
| Click Learn More on the API that you want to consume. This will open the API's details. |
| |
General | create_button
|
Multiexcerpt |
---|
MultiExcerptName | create_button |
---|
| No matter where you are in the API Management, the Create button is always displayed at the bottom right and opens the creation menu. |
| |
General | creation_wizard
|
Multiexcerpt |
---|
MultiExcerptName | creation_wizard |
---|
| In the next step, you need to enter the following mandatory settings: You can then enter a description. The description is optional and can also be entered or changed later on the details page. Click Next to continue. |
| |
General | enable_delete_button
|
Multiexcerpt |
---|
MultiExcerptName | enable_delete_button |
---|
| Option Delete is only enabled if you activate the checkbox. |
| |
General | info_mail_notifications
|
Multiexcerpt |
---|
MultiExcerptName | info_mail_notifications |
---|
|
Info |
---|
The notifications can also be sent by by email. This feature must be enabled during the the setup of your Scheer PAS installation. Ask your Scheer PAS administrator for help. |
|
| |
General | info_metrics
|
Multiexcerpt |
---|
MultiExcerptName | info_metrics |
---|
|
Tip |
---|
Refer to Metrics for detailed information about the available options. |
|
| |
General | info_rights_management
|
Multiexcerpt |
---|
MultiExcerptName | info_rights_management |
---|
|
Info |
---|
In API Management, a user can see all APIs for which he has explicit permissions (roles Viewer and Editor). The permissions are assigned in the corresponding organizations, refer to Administrating Organization Members > Applicable Roles. In addition, a user can be assigned the profile api_management_admin in the user management (refer to Administration Guide) which makes him a "superadmin" who can basically see and do everything in API Management (refer to Administration for details).
|
|
| |
General | organization_preset
|
Multiexcerpt |
---|
MultiExcerptName | organization_preset |
---|
| In that case, the organization is already set in the wizard. |
| |
General | plan_sign_up |
Multiexcerpt |
---|
MultiExcerptName | plan_sign_up |
---|
| In the Plans section, you find all available plans for the API and information on whether approval is required for a plan. Click Sign Up on the plan you want to register for. |
| |
General | successful_deletion
|
Multiexcerpt |
---|
MultiExcerptName | successful_deletion |
---|
| A toast message indicates successful deletion. |
| |
General | tip_entity_deletion
|
Multiexcerpt |
---|
MultiExcerptName | tip_entity_deletion |
---|
|
Tip |
---|
| Do not delete APIs, plans, or clients and recreate them if you want to change policies or settings. Instead: - As concerns APIs and clients: Retire the old version, so it will not be callable anymore. Alternatively, skip this step if you want both versions - old and new - to be available.
- Create a new version of the element you want to change.
- Re-publish or re-register the API or client.
|
|
| |
General | tip_infos_about_policies
|
Multiexcerpt |
---|
MultiExcerptName | tip_infos_about_policies |
---|
|
Tip |
---|
Refer to chapter Policies for an overview of the standard policies supplied with Scheer PAS API Management. Page Attaching Policies explains how to attach and configure a policy. |
|
| |
General | tip_navigation |
Multiexcerpt |
---|
MultiExcerptName | tip_navigation |
---|
|
|
| |
General | tip_visibility_concept
|
Multiexcerpt |
---|
MultiExcerptName | tip_visibility_concept |
---|
|
|
| |
Organizations | organization_best_practices
|
Multiexcerpt |
---|
MultiExcerptName | organization_best_practices |
---|
|
Tip |
---|
| We recommend the following best practices regarding organizations: - Create organizations as fine-granular as possible, e.g. one organization for each logical group of APIs (purchase, order processing, billing).
- Use a separate, dedicated organization for testing or development.
- Do not test your API in an organization that holds productive data.
|
|
| |
Plans | info_deleting_locked_plans
|
Multiexcerpt |
---|
MultiExcerptName | info_deleting_locked_plans |
---|
|
Info |
---|
You cannot delete a locked plan. Locked plans are deleted only when the entire organization is deleted. |
|
| |
Plans | locked_plan_unchangeable
|
Multiexcerpt |
---|
MultiExcerptName | locked_plan_unchangeable |
---|
|
Note |
---|
Once a plan is locked, it cannot be revised anymore. However, you can still create a new version of this plan. |
|
| - Plans
- API Tutorial 2: Creating a Plan
|
Plans | setting_validity_plan |
Multiexcerpt |
---|
MultiExcerptName | setting_validity_plan |
---|
| This setting is valid for all versions of the plan. |
| |
Policies | claim_availability
|
Multiexcerpt |
---|
MultiExcerptName | claim_availability |
---|
| All standard claims, custom claims and ID token fields are available (case sensitive). A special value of access_token will forward the entire encoded token. Nested claims can be accessed by using the JavaScript dot syntax (e.g: address.country, address.formatted). |
| |
Policies | cors_policy_chain_text
|
Multiexcerpt |
---|
MultiExcerptName | cors_policy_chain_text |
---|
| API Management sets the CORS headers in the following order: - CORS headers from the CORS policy have the highest priority.
- If no CORS policy has been defined, CORS headers from the external API are used.
|
| |
Policies | info_cors_list_input |
Multiexcerpt |
---|
MultiExcerptName | info_cors_list_input |
---|
|
Info |
---|
Confirm each field input with Enter to create various list entries. |
|
| |
Policies | info_java_syntax
|
Multiexcerpt |
---|
MultiExcerptName | info_java_syntax |
---|
|
Info |
---|
Regular expressions must be written in Java syntax. |
|
| |
Policies | info_self_signed_certificates
|
Multiexcerpt |
---|
MultiExcerptName | info_self_signed_certificates |
---|
|
Info |
---|
Self-signed certificates are currently not supported. |
|
| |
Policies | info_stateful_request_payload |
Multiexcerpt |
---|
MultiExcerptName | info_stateful_request_payload |
---|
|
Info |
---|
If you want to cache POST requests, you have to enable stateful request payload inspection in the settings of your API. |
|
| |
Policies | note_allowlist_blocklist
|
Multiexcerpt |
---|
MultiExcerptName | note_allowlist_blocklist |
---|
|
|
| |
Policies | note_enable_option
|
Multiexcerpt |
---|
MultiExcerptName | note_enable_option |
---|
| It is stongly recommended to enable this option. |
| |
Policies | policies_best_practices |
Multiexcerpt |
---|
MultiExcerptName | policies_best_practices |
---|
|
Tip |
---|
| We recommend the following best practices regarding policies: - Give a thought or two on where to add your policy, because policies can be added to clients, plans and APIs, which has impact on the policy chain.
- On API level, you will typically use modification policies, such as URL Rewriting or API Key.
- On plan level, you will typically use limiting policies, such as Rate Limiting. This way, each plan will allow for a different amount of requests.
- On client level, you will typically apply authentication and authorization policies, such as BASIC Authentication or Authorization, or other security policies.
- Testing APIs or verifying concepts with policies is much simpler with public APIs.
|
|
| |
Policies | policies_table_handling
|
Multiexcerpt |
---|
MultiExcerptName | policies_table_handling |
---|
| Click Add to create more rows in the table. Click Delete to remove selected rows. |
| |
Tips and Tricks | attaching_a_policy
|
Multiexcerpt |
---|
MultiExcerptName | attaching_a_policy |
---|
| A wizard supports you during policy configuration. Refer to Attaching Policies for a step-by-step guide. |
| |