Versions Compared

Old Version 1

changes.mady.by.user Thomas Schwarz

Saved on

compared with

New Version Current

changes.mady.by.user Annegret Bernhardt

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Clients must exist within the context of an organization. You can display the list of existing clients for an organization by navigating to the Clients tab for that organization on its details page:

You can also display all clients belonging to one of your organizations by choosing the option Clients > My Clients in the sidebar menu:

Multiexcerpt include
MultiExcerptNameapi_my_all_hint
PageWithExcerptINTERNAL:_api_excerpts

Click on the name of a client to open its details page:

Use the Client Details page to modify the client's meta data, policies and contacts. Once you have fully configured the client, don't forget to register it (see Registering a Client).

Multiexcerpt include
MultiExcerptNameapi_registered_client
DisableCachingtrue
PageWithExcerptINTERNAL:_api_excerpts

Basic Settings

The basic settings of a client are displayed in the frame on top:

If a client is registered, more options appear:

  • Name of the client
  • Description (changeable, click to open the editor)
  • Creation date
  • Creator
  • Status of the client (, , , )
  • Version number selection (see Versioning)
  • New Version button (see Versioning)
  • Configuration options
  • API Search link
  • New Contract link
  • New Version link
  • Register / Re-Register button
  • Unregister button

Client Details

Underneath the basic settings of the client its details can be configured. You will have to enter a minimum amount of data before the client can be registered with the gateway. In particular, the client must have at least one API contract (see tab Contracts).

Use the tabs on the left side of the page or the links on the overview page to navigate to the different details:

If a client has been registered, the detail list is extended by more options:

Contracts

The Contracts tab is where you can manage all of the API contracts for this client. An API contract is simply a link between this client and a provided API this client consumes. Open tab Contracts to see a list of all APIs this client is currently contracted to utilize:

OptionDescription
API SearchUse the API Search to filter the list of APIs by organization or API name.
New ContractClick the New Contract button to create a new contract for this client.
Break ContractThe button Break Contract is displayed for every API in the list. Use it to delete the link between the corresponding API and this client.
Break AllIf you want to delete all contracts of this client, use the button Break All. As this will erase all contracts, you will have to confirm a deletion dialog.

Policies

Open tab Policies to display the list of policies defined for this client. These policies will be applied to all API invocations made by the client, in addition to whatever policies are defined by the API itself. To add another policy to this client, use the Add Policy button. Doing so will redirect you to the page Add Policy, where you can choose a policy and customize it:

Multiexcerpt include
MultiExcerptNameapi_link_to_policy_page
DisableCachingtrue
PageWithExcerptINTERNAL:_api_excerpts

Multiexcerpt include
MultiExcerptNameapi_move_policies
PageWithExcerptINTERNAL:_api_excerpts

If you want to delete a policy from this client, use the Remove button of the policy in question.

APIs

Multiexcerpt include
MultiExcerptNameapi_displayed_when_registered
PageWithExcerptINTERNAL:_api_excerpts

Use the APIs tab to figure out how to invoke an API once you have concluded a contract for it. The APIs tab lists all of the APIs consumed by this client. This information is derived from the set of contracts the client has entered into. You can also download the API registry information in JSON or XML format, just use one of the buttons Download as JSON or Download as XML:

The entries in the table on page Client APIs show you the following information:

OptionDescription
APIShows the name of the organization / the name of the API. Click on one of the links to open the corresponding details page.
VersionThe version name / number of the API is displayed here.

Plan

Displays the name of the plan.

Endpoint

A click on the icon  opens a pop-up window showing the API endpoint. It allows you to provide the necessary API Key. You can also find the information for host and basePath. Use the button to copy the needed information:

  • As Query Parameter: The Link contains host, basePath and API Key:
    • host: Content after http:// until the first / (in the example localhost:8383).
    • basePath: Content after the host until the question mark (in the example /gateway/ACMESupportDev./SupportManager/1.0).
    • API Key: Content after apikey= (in the example ac407a32-51-ea-4470-82f0-...).
  • As HTTP Request Header: Contains the X-API-Key.

Test

Click on the Try-It-Out link to open the Swagger API Definition where you can send test calls to the API. For more information on testing APIs, refer to Testing APIs.

Tip

You can find more information on how to use the Swagger UI on the Swagger pages.


Metrics

Multiexcerpt include
MultiExcerptNameclient_metrics
PageWithExcerptMetrics

Change Log

Navigate to the Change Log tab if you want to see an overview of changes made for this client. All configuration changes made by API Management users associated with this client are listed here:


Panel
titleOn this Page:

Table of Contents


Panel
titleRelated Pages:

Otp
Floatingfalse
maxHLevel2

rp