Chapter | Name | Excerpt | Usage |
---|
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. |
|
| |
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 | 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 | 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:
A drop-down list Organization will appear. - Choose the organization you want to search or create your client in.
If clients are already available for the chosen organization: - Select one from the list of available clients below or enter a name in field Search or create to create a new client.
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 |
---|
| A wizard will now guide you through the creation process. First you For each new API, 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_metrics
|
Multiexcerpt |
---|
MultiExcerptName | info_metrics |
---|
|
Tip |
---|
Refer to Metrics for detailed information about the available options. |
|
| |
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 | 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_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 |
---|
|
|
| |
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_table_handling
|
Multiexcerpt |
---|
MultiExcerptName | policies_table_handling |
---|
| Click Add to create more rows in the table. Click Delete to remove selected rows. |
| |