API Discovery
The API Hub tab page provides a powerful and intuitive way to discover and evaluate APIs before integrating or bookmarking them.
API Search
There are two methods available to quickly discover the right APIs for your projects.
Keyword Search
Search for API by name, function, or description.
Filtering Options
Categories: Narrow results by application, such as WMS, CRM,DI.
Tags: Filter API by business tags, such as warehouse, integration, fulfillment, and processing.
Price: Choose between Free, Paid, or All Prices.
View API Details
The API Details page provides comprehensive information about each API, helping users understand its structure and how to integrate it effectively.
| Field | Description |
|---|---|
| Method & Endpoint Path | Displays the HTTP method (e.g., POST) and the full API path used for the request. |
| Request Parameters | Include details of the required query and path parameters, along with data type and descriptions. |
| Request Body | Shows the expected body (typically in JSON), including a list of parameters, their data types, whether they are required, and sample values. |
| Response-Data Schema | Describe the structure of the API’s response, including fields, types, and nested objects if applicable. |
| Response Example | Provides a sample response to help users understand what to expect when the API is called successfully. |
Run API & Generate Code
Generate Code
The Generate Code feature enables users to quickly obtain code snippets corresponding to the API request they've configured in the Run API panel.
User can generate client-side code snippets in various programming languages, including: Shell, JavaScript, Java, Go, Python, C#. Then the code snippets are ready-to-use and can be copied with a single click to accelerate API integration into the user's own applications.
Run API
The Run API feature allows users to directly test and interact with any API of interest, enabling them to understand its behavior and output in real time. The key capabilities include:
-
Support for Common HTTP Methods: user can send API requests using standard methods such as GET, POST, PUT, and DELETE.
-
Parameter Input Based on API Docs: the request form auto-adapts based on the API documentation, allowing users to enter required parameters in the correct format before sending the request.
-
Detailed Response Retrieval: user can view the key information including status code, body parameters and response time.
-
Request History: all executed requests are recorded, user can revisit previous requests, review results, and re-run them with a single click.
Bookmark API
This feature provides quick access to frequently used or preferred APIs, enhancing productivity and workflow efficiency. User can easily bookmark APIs they are interested in from the API Hub.
-
In the API list view, simply click the Bookmark icon located in the footer section of the API card to add the API to your favorites.
-
Once bookmarked, the API will automatically appear under My APIs > My Collections.
-
User can revisit this section to manage their favorite APIs and unfavorite any item at any time by clicking the bookmark icon again.