Page History

...

Figure 1: Fiorano API Management Dashboard Home page

...

To develop and deploy API projects, a new environment needs to be created, which can be done by performing the following actions:

...

• Servers: Lists the Server already added.
• Available Servers: Lists the servers available to be added.

...

To add a proxy project to an existing backend REST/HTTP service, perform the following actions:

...

On the upper-right part of the page, click the small drop-down _{Image Removed} button beside (on the right) the Deploy _{Image Removed} button to list available deployment environments, select the desired environment to deploy your project.

...

Policies are used to enforce various modifications/security checks. To add a policy, please perform the following actions in the API Management Dashboard:

...

After adding policies, to attach the created policy to a Project, perform the following actions:

1. Under the same window, click the Resources tab.
2. A resource named 'DefaultResource' will already be present under the tab; you may add a new resource or edit the Default Resource.
3. Click on the resource to view the resource editor on the right side. Policies can be attached at 4 places, each of them appearing as an arrow on the resource editor.
   1. Selecting any of these arrows will open an editor window.
   2. Click the Edit_{Image Removed} button beside the editor to display the below sections:
   • • Policies: Lists the policies (added to that endpoint)
     • Available Policies : Lists the policies available to be added.
4. Select the required policies and add them to the endpoint by dragging it from Available Policies section to Policies section or by using the Arrow button available between the sections.
5. After this is done, click Save Image Removed button to apply the changes and to attach your policy to the project

...

By default, the gateway server of server1 profile listens to port: 2160 enabling access to the deployed API projects/products.

To access the deployed backed service, you can use the URL in the following format:

http://<ip-address-of-gateway-machine>:2160/<project-context-path>/<version-number>

If this returns the desired outcome, after calling the backed service API, that means your project is successfully configured.

...

WSDL projects are used to convert SOAP-based APIs to RESTful APIs. To add a WSDL Project, perform the following actions in the API Management Dashboard:

...

This should automatically fetch the WSDL details and create the project with attached policies; you may add more policies as needed.

Deploy the project and we are good to go.

...

Click the Apps prompt in the API Management Dashboard and follow the sections below to add a product, add Clients and add Client Subscriptions respectively.

To add a Product

1. Click the Products tab, and click the Add _{Image Removed} button to add a new product.
2. Provide the desired Product ID in the New Api Product pop-up and click OK.
3. Select the Product ID to navigate to navigate to the respective Product Configuration page.
4. Configure the product as per your requirement and add the desired projects to this product using projects selection box at the bottom of this page. Click  Edit _{Image Removed} button to see the sections:
   • Projects in Product: Lists the projects added in the Product.
   • Available projects: Lists the projects available to be added.
5. Click Save button present at the bottom of the screen to add the product.

To add a Client

1. Click the Clients tab and click the Add _{Image Removed} button to add a new client.
2. Provide the desired Client ID in the New Client pop-up and click OK.
3. Select the Client ID to navigate to the respective Client Configuration page.

4. Configure the client details such as Client Name, Email and Status as per requirement.

5. And the desired attributes and corresponding values by clicking Add _{Image Removed} button and then adding values under Attribute and Value columns respectively.

   Note
   Use Delete Image Removed icon to remove an attribute.

6. Click Save button present at the bottom of the screen to add the client.

To Add a Client Subscription

Client Subscription is basically a combination of single client and multiple products. To add a Client Subscription, perform the following actions under Apps prompt:

1. Click the Client Subscriptions tab and click the Add _{Image Removed} button to add a new subscription.
2. Provide the desired Client Subscription ID in the New Client Subscription pop-up and click OK.
3. Select the Client Subscription ID to navigate to the respective Client Subscription Configuration page.
4. Configure the Client Subscription details as per requirement and click Save.
5. Add the necessary products to the app. You may edit the properties in the Properties section.
6. Click Save to add the Client Subscription.

After the Client Subscription is created, click the project selected in the API Products section to display the Consumer Key and Consumer Secret number. These digits can be changed by clicking Regenerate button.

For secure access to this project, the generated key and secret need to be passed while calling the API.

Image Removed
Figure 7: Consumer Key and Consumer Secret numbers appearing as API Product Info

...

To add a Verify API Key Policy, please perform the following actions in the API Management Dashboard:

1. Click the API Projects prompt.
2. Double-click the project to which the policy is to be added.
3. Select the Policies tab and click the Add _{Image Removed} button to add a new policy.
4. In the Add New Policy pop-up, add a policy ID and select the type of policy to be added (Eg: Security > Verify API Key) from the Policy drop-down and click OK.
5. Select the Policy ID to navigate to the respective Policy Configuration page.
6. Configure the Key Source as needed by clicking the Edit _{Image Removed} button and then click Save to add the policy.

After the policy is created, attach this policy to the project by performing the following actions under the same page:

1. Go to the Resources tab.
2. You may edit the DefaultResource which is already present here or you may add a new resource. Click the resource to open the resource editor and then attach this policy to the proxy request endpoint.
3. Click Save to attach the policy to the project.

Now you can deploy the project with the Verify Key Policy attached to the project.

...

To test this policy, perform the following actions:

1. Create a sample Verify API Key policy (referring to Adding Verify API Key Policy section above) with the following configuration in Key Source:
   • Type: PARAMETER
   • Name: APIKey
   • Default value: Provide a value of your choice.
2. Create Client Subscription by following the steps mentioned in Adding Products, Clients and Client Subscriptions section, and deploy the project.
3. From the Client Subscriptions listing (API Products section under Client Subscription Configuration), get the Consumer Key.

4. Pass this value to the API proxy access URL on the gateway server as a parameter in the following format:

   Code Block
   http://<ip-address-of-gateway-machine>:2160/<project-context-path>/<version-number>?Apikey=<ConsumerKey>

If the Consumer Key is correct, the request should succeed, else an Authentication failure code will be displayed.