Overview
An API marketplace is a centralized online platform that enables the exchange of application programming interfaces (APIs) between providers and consumers. The eZintegrations API Marketplace offers features such as API listings, search and discovery tools, testing environments, pricing structures, and ecosystem integration support.
This platform provides an interactive environment where organizations can discover, evaluate, and integrate APIs to support digital collaboration and business operations.
When to Use
The API Marketplace should be used when users need to discover, evaluate, test, and select APIs for integration within their business workflows.
- When searching for available APIs for integration projects
- When comparing API features, pricing, and categories
- When testing APIs before implementation
- When selecting APIs during integration bridge configuration
How It Works
The API Marketplace aggregates APIs from multiple providers and displays them in a searchable and categorized interface. Users can browse, filter, test, and add APIs to a cart for later use.
Selected APIs can then be applied directly during integration bridge configuration through the platform interface.
Accessing the API Marketplace
Users can access the API Marketplace using the following methods:
- Log in and locate the Marketplace option on the dashboard. Click it to access the marketplace.
- Use the Marketplace option located in the left sidebar of the screen.
- During integration bridge setup, in the data source, data target, or data operations step, select the source or target type as API or data operation as API. Then, click the Marketplace option below the product name selection menu.
Marketplace Features
The API Marketplace provides tools to help users discover, evaluate, and manage APIs efficiently.
API Listing
API providers can list their APIs with detailed information, including functionality, endpoints, authentication methods, and pricing.
API Category Selection
Users can select the desired API category from the top dropdown menu or use the search bar to locate specific APIs.
Filtering Options
Checkbox filters are available on the left side of the page to refine API listings based on specific requirements.
- Brand
- Product name
- Business object
- Method
- Type
- Price
Sorting Capabilities
APIs can be sorted based on newest arrivals or latest updates, allowing users to view recently added or updated offerings.
Direct Testing and Cart Addition
Users can test selected APIs directly within the marketplace environment and add them to the cart for further processing.
Cart Management
The marketplace supports adding multiple APIs to a cart, enabling efficient selection and management. Users can review, modify, or remove items as needed.
Cart Management
Add to Cart
Follow these steps to add an API to the cart:
- Step 1: In the marketplace, select the desired API from the available list.
- Step 2: Select the Add to Cart option to add the chosen API to the cart.
Delete from Cart
Follow these steps to remove an API from the cart:
- Step 1: Access the cart option within the marketplace interface.
- Step 2: Use the delete option next to the listed API to remove unnecessary selections.
How to Use APIs from the Cart
APIs added to the cart can be directly applied during integration bridge configuration.
- Step 1: Add a new integration bridge or edit an existing one.
- Step 2: In the data source, data target, or data operations step, navigate to the API selection.
- Step 3: Select the Add from Cart option to include the required APIs in the integration process.
Troubleshooting
If users experience issues while accessing or using the API Marketplace, consider the following:
- Verify that you are logged in and have access to the marketplace.
- Ensure that the Marketplace option is visible on the dashboard or sidebar.
- Confirm that APIs have been added to the cart before attempting to use them.
- Refresh the interface if listings or cart updates are not displayed correctly.
Frequently Asked Questions
What is the API Marketplace?
The API Marketplace is an online platform that allows users to discover, test, and select APIs for integration within the eZintegrations environment.
How can I access the marketplace?
Users can access the marketplace from the dashboard, left sidebar, or during integration bridge setup.
Can I test APIs before adding them to the cart?
Yes, users can test APIs directly within the marketplace before adding them to the cart.
How do I remove an API from my cart?
APIs can be removed by using the delete option available next to each listed API in the cart.
Where can I use APIs added to the cart?
APIs added to the cart can be used during integration bridge configuration in the data source, data target, or data operations step.
Notes
The API Marketplace supports efficient API discovery and selection within the integration platform. Users should regularly review available APIs and cart selections to ensure alignment with project requirements.
Only features and workflows described in this documentation are supported.
