Page History
Table Filter | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
|
API Management Guide
Step by Step Guides
step_by_step_policies
Multiexcerpt | ||
---|---|---|
| ||
|
goto_chapter_organizations
Multiexcerpt | ||
---|---|---|
| ||
|
goto_chapter_apis
Multiexcerpt | ||
---|---|---|
| ||
|
api_definition_details
Multiexcerpt | ||
---|---|---|
| ||
|
General Notes, Infos, Tipps
note_read_confirmation_dialog
Multiexcerpt | ||
---|---|---|
| ||
|
api_save_when_finished
Multiexcerpt | ||
---|---|---|
| ||
Do not forget to click the Save button when you have finished. |
api_displayed_when_published
Multiexcerpt | ||
---|---|---|
| ||
|
api_displayed_when_registered
Multiexcerpt | ||
---|---|---|
| ||
|
api_link_to_policy_page
Multiexcerpt | ||
---|---|---|
| ||
|
api_version_number_note
Multiexcerpt | ||
---|---|---|
| ||
|
api_work_with_items
Multiexcerpt | ||
---|---|---|
| ||
Click to add a new item to a list, click to show/hide the list of items. |
Terms & Definitions
definition_organization
Multiexcerpt | ||
---|---|---|
| ||
Almost everything in the API Management data model exists in the context of an organization:
|
definition_plan
Multiexcerpt | ||
---|---|---|
| ||
A plan is a set of policies that defines the level of service the API Management provides for an API.
|
definition_api
Multiexcerpt | ||
---|---|---|
| ||
APIs 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. |
definition_client
Multiexcerpt | ||
---|---|---|
| ||
The client is the consumer of the API:
|
definition_policy
Multiexcerpt | ||
---|---|---|
| ||
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 Scheer PAS API Management uses to manage your APIs.
|
api_contracts_and_keys
Multiexcerpt | ||
---|---|---|
| ||
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.
|
Organizations
api_org_creation
Multiexcerpt | ||
---|---|---|
| ||
|
APIs
public_api_testcode
Multiexcerpt | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
private_api_testcode
Multiexcerpt | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
Policies
api_move_policies
Multiexcerpt | ||
---|---|---|
| ||
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: |
api_blacklist_whitelist
Multiexcerpt | ||
---|---|---|
| ||
|
api_enable_option
Multiexcerpt | ||
---|---|---|
| ||
|
api_no_ipv6
Multiexcerpt | ||
---|---|---|
| ||
|
Clients
api_registered_client
Multiexcerpt | ||
---|---|---|
| ||
|
swagger_ui
Multiexcerpt | ||
---|---|---|
| ||
|
Plans
locked_plans
Multiexcerpt | ||
---|---|---|
| ||
|