API Management
  • 01 Aug 2022
  • 3 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

API Management

  • Dark
    Light
  • PDF

Introduction

API Management (APIM) assists organizations in publishing APIs to external, partner, and internal developers to maximize the value of their data and services.

APIM API

  • APIs are the foundation of an API Management service instance. Each API represents a set of operations available to developers. Each API includes a reference to the back-end service that implements the API, and its operations correspond to the back-end service's operations.

  • When APIs are used to include critical business logic in a solution, it is necessary to evaluate the API Management APIs' dependability, efficiency, and performance.

Resource Dashboard

APIM API Dashboard.png

Users are provided with an in-built Resource Dashboard for APIM API resources with the following widgets:

1. Unauthorized Requests
2. Data Transfer
3. Success Requests
4. Failed Requests
5. Request Summary
6. Response Time Summary
7. Service Time Summary
8. Response Time Maximum vs Minimum
9. Cache Hit Vs Miss
10. Request Success Vs Failure

Stay on track with the metric values for enhanced business performance.

Monitoring

  • Users can monitor their APIM API resources by configuring the metrics available for monitoring.
  • Navigate to the Monitoring section of the resource to configure the monitoring rules for APIM API.
  • Users can specify monitoring threshold values based on their needs.

APIM API.png

Properties

  • Users can view the properties of the APIM API by clicking the Properties option available at the top.

APIM API Properties.png

APIM Operation

  • API operations correspond to the operations carried out by the back-end service.

  • API Management operations are highly customizable, allowing for control over URL mapping, query and path parameters, request and response content, and operation response caching.

  • Policies for rate limits, quotas, and IP restrictions can also be implemented at the API or individual operation level.

Resource Dashboard

Users are provided with a default Resource Dashboard for all APIM Product resources when associated with a Business Application.

APIM Operation Dashboard.png

The following widgets are available by default to give users an idea of the resource dashboard:

1. Unauthorized Requests
2. Data Transfer
3. Success Requests
4. Failed Requests
5. Request Summary
6. Response Time Summary
7. Service Time Summary
8. Response Time Maximum vs Minimum
9. Cache Hit Vs Miss
10. Request Success Vs Failure

Monitoring

  • Users can monitor their APIM Operation resources by configuring the metrics available for monitoring.

  • Navigate to the Monitoring section of the resource to configure the monitoring rules for APIM Operation.

  • Users can specify monitoring threshold values based on their needs.

  • When the monitoring rule type is a metric, selecting metrics against metric rules is also an option.

APIM Operation.png

Properties

  • Users can view the properties of the APIM Operations by clicking the Properties option available at the top.

APIM Operation Properties.png

APIM Product

  • APIs are exposed to developers through products. API Management products have one or more APIs and are labeled with a title, description, and terms of use.

  • Products can be either open or closed. Protected products require a subscription before they can be used, whereas open products can be used without one.

  • When a user subscribes, they receive a subscription key that can be used with any API in that product. Subscription approval is configured at the product level and can be either manual or automatic.

Functionality

  • Customers can use Serverless360 to perform actions such as publishing and unpublishing the APIM Product.

APIM Product functionality.png

Resource Dashboard

Users can make use of the default dashboard for APIM Product resources to visualize the metric data for further reference.

APIM Product Dashboard.png

The following widgets are available by default to the resource dashboard:

1. Unauthorized Requests
2. Data Transfer
3. Success Requests
4. Failed Requests
5. Request Summary
6. Response Time Summary
7. Service Time Summary
8. Response Time Maximum vs Minimum
9. Cache Hit Vs Miss
10. Request Success Vs Failure

Monitoring

  • Users can monitor their APIM Product resources by configuring the state and metrics available for monitoring.

  • Navigate to the Monitoring section of the resource to configure the monitoring rules for APIM Product.

  • Users can specify monitoring threshold values based on their needs.

APIM Product.png

Properties

  • Users can view the properties of the APIM Product by clicking the Properties option available at the top.

APIM Product Properties.png


Was this article helpful?