C1000-138 IBM API Connect v10.0.3 Solution Implementation Questions and Answers

In IBM API Connect v10.0.3, rate limiting for APIs can be defined in two primary places: Plan and Catalog .

Plan : Rate limiting is typically defined at the Plan level. A Plan in API Connect specifies how an API or a group of APIs is exposed to consumers. It can include rate limits, quotas, and other restrictions. Defining rate limits at the plan level ensures that each application subscribed to the plan adheres to the specified API consumption limits, such as the number of API calls allowed within a given time period.

Catalog : The Catalog is another place where rate limits can be defined. A Catalog represents a collection of APIs and their configurations, including security and rate limiting policies. Rate limits defined at the Catalog level apply globally to all APIs and applications within that Catalog, providing an overarching control mechanism to enforce consumption limits across different APIs.

These two locations allow flexibility in controlling API usage, either by restricting usage per plan (at a more granular level) or globally across all APIs within a catalog.

References:

IBM API Connect v10.0.3 - Now Available

IBM API Connect Documentation

An Organization Manager is responsible for creating Consumer organizations, assigning customer representatives as owners, and managing the relationship between the Provider organization and each Consumer organization. This role has the necessary permissions to create new organizations, invite users to become owners, and oversee the interactions between the Provider and Consumer organizations.

References:

IBM API Connect: Creating and Managing Organizations

IBM API Connect: Inviting Users to Organizations

IBM API Connect: Managing Organization Relationships

An administrator would run the apic apic-config: get Portal CLI command to view the configured user registries, payment methods, permissions, and TLS profiles for the Portal . This command provides a comprehensive overview of the Portal ' s configuration settings, allowing the administrator to verify and modify them as needed.

References:

IBM API Connect: Developer Portal CLI commands

IBM API Connect: Managing Portal Configuration

When creating a SOAP proxy API from an existing SOAP service in IBM API Connect, a key step is to upload a single .zip file that contains the WSDL (Web Services Description Language) file and any associated dependent documents. This enables IBM API Connect to understand the service definition and its dependencies, allowing it to create the proxy API correctly. This method is necessary to ensure all components required for the SOAP API are packaged together and recognized during the import process.

$ref Usage : The $ref keyword is used in OpenAPI (formerly Swagger) specifications to reference reusable components, such as schemas, parameters, and responses, defined elsewhere in the document or in external files.

Replacement Mechanism : When an API is published, the $ref is processed and replaced with the actual contents of the referenced file or component. This allows for modular and maintainable API definitions, where common elements can be defined once and reused across multiple APIs.

YAML and JSON : The $ref keyword can be used in both YAML and JSON files, which are common formats for defining OpenAPI specifications. It is not limited to YAML files.

Location Flexibility : $ref can be defined at various levels within the YAML or JSON file, not necessarily at the root level. It can be used within objects, arrays, and other structures as needed.

Gatewayscript : While Gatewayscript can include external files, it does not use the $ref keyword in the same way as OpenAPI specifications. Gatewayscript has its own mechanisms for including and referencing external scripts.

References :

IBM API Connect documentation on OpenAPI specifications and the use of $ref.

General principles of API design and modularization using OpenAPI.

Application developers can create better apps using APIs by combining multiple APIs to create composite apps . This approach allows developers to leverage the functionality of different APIs to create more valuable and innovative applications. By combining APIs, developers can access a wider range of data and functionality, create more personalized experiences, and solve complex problems more effectively.

References:

IBM API Connect: Creating Composite APIs

IBM API Connect: Building Better Apps with APIs

Packaging Format : Gateway extensions in IBM API Connect v10.0.3 are packaged as .zip files. This format is used to bundle all necessary files and configurations required for the extension.

Upload Process : These .zip files are then uploaded to the Gateway through the API Manager interface. The API Manager handles the deployment and integration of these extensions into the Gateway.

Documentation Reference : According to the IBM Certified Solution Implementer - API Connect v10.0.3 documentation, the correct packaging format for Gateway extensions is .zip files 1 .

1 :  IBM Certified Solution Implementer - API Connect v10.0.3 Documentation

Setting Context Variables : In Gatewayscript policies, the context.set function is used to set context variables. The syntax context.set( ' my.vars.amount ' , 100) creates a JSON structure where my.vars is an object containing the key amount with the value 100.

JSON Structure : This method of setting context variables generates a JSON structure, which is a common format for data interchange in APIs. The resulting structure would be { " my.vars " : { " amount " : 100 } }.

Usage in Policies : This approach allows for easy manipulation and access to variables within the GatewayScript, facilitating dynamic API behavior based on the context.

Documentation Reference : According to the IBM Certified Solution Implementer - API Connect v10.0.3 documentation, using context.set in this manner is the correct way to generate the specified JSON structure 1 .

1 :  IBM Certified Solution Implementer - API Connect v10.0.3 Documentation

To monetize a Product in API Connect, you must first configure a billing integration resource for the Provider organization. This resource defines the payment gateway or other payment method that will be used to process payments for API subscriptions. Once a billing integration resource is configured, you can create paid plans for your Products and enable billing for those plans.

References:

IBM API Connect: Monetizing APIs

IBM API Connect: Configuring Billing Integration Resources

To add a user that was previously removed from a Provider organization that uses a Local User Registry (LUR), the user must re-register using the invitation link sent by the Provider organization owner or a user with the appropriate role . This ensures that the user is added back to the organization with the correct permissions and settings.

References:

IBM API Connect: Managing Users in Local User Registries

IBM API Connect: Inviting Users to Organizations

To ensure that all errors are caught within an assembly in API Connect, you can add a default catch policy to the assembly. This catch policy will capture any errors that are not handled by other policies in the assembly, providing a centralized location for error handling and logging.

References:

IBM API Connect: Designing and Building Assemblies

IBM API Connect: Handling Errors in Assemblies

API Properties : In IBM API Connect, API properties are configuration settings that can be used to customize the behavior of APIs. These properties can be defined at various levels, including the API, Product, and Catalog levels.

Catalog-Specific Values : A property can be assigned a specific value for each Catalog. This allows for different configurations and behaviors of the same API when deployed in different Catalogs. For example, an API might have different endpoint URLs or security settings in development, testing, and production environments.

Runtime Changes : While some properties can be modified at runtime, this is not a general rule for all API properties. The ability to change property values at runtime depends on the specific property and its configuration.

Pre-defined Properties : API properties can be both pre-defined and custom-defined. Pre-defined properties are provided by IBM API Connect, while custom properties can be created by API developers to suit specific needs.

Spaces and Properties : If Spaces are enabled, properties can indeed have Space-specific values. This allows for further granularity in configuration, enabling different settings within the same Catalog based on the Space.

References :

IBM API Connect documentation on API properties and their configurations.

Best practices for managing API properties in IBM API Connect.

To create and then subscribe an application to a product in IBM API Connect, the correct order of activities would be as follows:

Log in to API Manager UI : The first step is to log into the API Manager user interface, where the APIs and products are managed.

Go to Manage Catalogs and then the Catalog to work with : After logging in, navigate to the specific Catalog where you want to manage the products and subscriptions.

Click on the Applications tab : Once in the Catalog, you need to navigate to the Applications tab, which allows you to manage applications.

Add an Application : In the Applications tab, you can add a new application that will be subscribed to an API product.

Fill the form and create it : After selecting to add an application, you must complete the required form and create the application.

On the Applications tab, navigate to Create a subscription : With the application created, navigate to the area where you can create a subscription for this application.

Select the Product/Plan combination for the API and create it : Finally, select the appropriate product and plan combination to which the application will subscribe and complete the subscription process.

In summary, the correct order is:

Log in to API Manager UI.

Go to Manage Catalogs and then the Catalog to work with.

Click on the Applications tab.

Add an Application.

Fill the form and create it.

On the Applications tab, navigate to Create a subscription.

Select the Product/Plan combination for the API and create it.

Consumer Responsibility : In IBM API Connect, the consumer (or developer) who has subscribed to an API Product is responsible for managing the migration of their subscribed application to a new Product. This ensures that the consumer has control over their application’s dependencies and can test the new Product before fully migrating.

Migration Process : When a new Product is introduced, consumers need to subscribe to the new Product and update their application configurations to use the new API endpoints and plans. This process involves:

Reviewing the new Product’s documentation and capabilities.

Testing the new Product in a staging environment.

Updating application code and configurations to point to the new Product’s endpoints.

Subscribing to the new Product through the Developer Portal.

Role of Admins and Community Managers :

Admins : While the admin of a Developer Portal can facilitate the migration process by providing necessary tools and support, they do not enforce the migration.

Community Managers : They manage the overall community and can provide guidance, but the actual migration task is performed by the consumer.

Product Plans : The plans of the new Product do not necessarily have to be the same or less restrictive than those of the original Product. The new Product may offer different plans with varying levels of access and features.

References :

IBM API Connect documentation on managing API Products and subscriptions.

Best practices for API consumer management and migration in IBM API Connect.

OAuth Provider Customization : When customizing a native OAuth provider in IBM API Connect, certain configurations and policies can affect its readiness for immediate use.

TLS Profile Reference : Adding a policy that references a TLS (Transport Layer Security) profile introduces additional security configurations that need to be validated and applied. This process can delay the immediate readiness of the OAuth provider.

Impact of TLS Profiles : TLS profiles are used to secure communications and ensure data integrity and confidentiality. When a policy with a TLS profile reference is added, the system must ensure that the TLS settings are correctly configured and operational, which can take additional time.

Other Options :

Transform Policies : These are used to modify the request or response messages and do not inherently delay the readiness of the OAuth provider.

Grant Types : Adding grant types involves configuring the OAuth provider to support different methods of obtaining access tokens, which is a standard part of customization and does not delay readiness.

Logic Operators : Using logic operators in the assembly is related to the flow control of the API assembly and does not directly impact the readiness of the OAuth provider.

References :

IBM API Connect documentation and best practices for OAuth provider customization.

General principles of TLS and its impact on API security configurations.