Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Private APIs are only accessible for known consumers, called clients. Every client version has an individual key to access the API.
Create Client "Spring Corp."
Panel | ||||
---|---|---|---|---|
| ||||
David Stringer wants to enable the customer Spring Corp. to consume his PrivateEchoAPI with the higher rate limit. Therefore, he creates a client for the customer. |
Divinfo | ||||||
---|---|---|---|---|---|---|
| ||||||
Expand |
| |||||
|
In API Management, search for your organization and click Clients. | |||
In tab Clients use the link Click here to create a new client.
| |||
A wizard supports you during the creation process. First, enter a Name and an optional Description for the client:
Click Next. | |||
The Summary allows you to check your entries. Click Create Client to confirm your settings and create the new client. Click Back if you want to adapt your entries. | |||
The new client has been created. The client's detail page opens automatically. Refer to API Management Guide > Clients to learn more about the details of a client and its configuration options. |
Create a Contract for "Spring Corp."
The relation between client and API is defined via a contract and a plan.
Panel | ||||
---|---|---|---|---|
| ||||
David Stringer wants to enable the customer Spring Corp. to consume his PrivateEchoAPI with the higher rate limit. Therefore, he creates a contract between the PrivateEchoAPI and the client Spring Corp. for plan Gold. |
Divinfo | ||||||
---|---|---|---|---|---|---|
| ||||||
| expand
| |||||
|
In tab Overview > Contracts use the link Click here to create a new contract in the API Developer Portal. This will redirect you to the Developer Portal. | |||
Since you featured your API, it is displayed directly on the portal homepage. Click Learn more to open the API details. | |||
In the Plans section, you find all available plans for the API and information on whether approval is required for a plan. Click Sign Upon plan Gold. | |||
Now follow the wizard through some simple steps:
Only the Spring Corp. client exists in your organization. This client is therefore already selected. | |||
In step 2, the summary displays the API-related information. Click Confirm to send your request. | |||
In the next step, API Key and Endpointare provided.
Click Finish to close the wizard. | |||
You are redirected to tab My Clients. This tab provides an overview on all your clients and contracts and a table of contents on the right side for easy navigation. | |||
Open API Management again:
| |||
| |||
Your API is ready for testing. |
Panel |
---|
Panel |
---|
| ||
|
Panel | ||
---|---|---|
|
Otp | ||
---|---|---|
|