Overview

The APYHub API Connector for OutSystems in the E-Commerce Quick Tools category provides seamless integration with a variety of APYHub APIs that are essential for e-commerce applications. This connector allows developers to easily integrate functionalities such as currency conversion, barcode generation, QR code creation, and image thumbnail generation directly into their OutSystems applications. These tools are designed to enhance the efficiency and capabilities of e-commerce platforms by automating essential tasks.

Key Features

This connector supports the following server actions from the E-Commerce Quick Tools category:

1. Convert Currency Action: Converts an amount from one currency to another based on the latest exchange rates.
2. Convert Currency to Multiple Currencies Action: Converts an amount from one currency to several other currencies simultaneously, streamlining the process of multi-currency pricing.
3. Generate Barcode: Generates a barcode image for product identification, inventory management, or any other use case requiring a machine-readable code.
4. Generate QR Code (Visiting Card) Action: Creates a QR code containing visiting card details, which can be scanned to quickly save contact information.
5. Generate QR Code (WiFi Details) Action: Creates a QR code containing WiFi details (SSID and password), allowing users to easily connect to a network by scanning the code.
6. Generate Image Thumbnails Action: Generates thumbnails from images, optimizing them for faster loading and better performance in e-commerce product galleries.

Prerequisites

• An active APYHub account.
• Obtain an APY Token from the APYHub official site.

Installation

1. Download the APYHub API Connector from the OutSystems Forge.
2. Install the component in your OutSystems environment.
3. Configure the component by setting the APY Token in the API Connector settings.

Configuration

1. Navigate to the Service Center in your OutSystems environment.
2. Go to Applications and select the APYHub API Connector.
3. Open the APYHub API Connector configuration screen.
4. Enter your APY Token obtained from the APYHub official site.
5. Save the configuration.

Using the APYHub API Connector

Server Actions

Convert Currency Action

Converts a specified amount from one currency to another based on real-time exchange rates.

Parameters:

• Source (Text): The original currency code (e.g., inr).
• Target (Text): The target currency code (e.g., eur).

Convert Currency to Multiple Currencies Action

Converts an amount from one currency to multiple currencies in a single request.

Parameters:

• Source (Text): The original currency code.
• targets (List of Text): A list of target currency codes.

Generate Barcode

Generates a barcode image for product labeling, inventory management, or other identification needs.

Parameters:

• Content (Text): The data to be encoded in the barcode.

Generate QR Code (Visiting Card) Action

Creates a QR code that encodes contact information, ideal for digital business cards.

Parameters:

.

Generate QR Code (WiFi Details) Action

Generates a QR code that encodes WiFi network details, allowing users to connect by simply scanning the code.

Parameters:

Generate Image Thumbnails Action

Creates a thumbnail image from a larger image, optimizing it for use in e-commerce galleries and reducing loading times.

Parameters:

• image (Binary): The original image file.
• width (Integer): The desired width of the thumbnail.
• height (Integer): The desired height of the thumbnail.

Error Handling

• Invalid Token: Ensure that the APY Token is correctly configured. If invalid, request a new token from APYHub.
• API Limits: Monitor your daily API usage to avoid exceeding the free version limit of 5 API calls per day. Consider upgrading your APYHub plan if more calls are needed.
• Invalid Input: Ensure that the input data is correctly formatted and valid for the respective server action.

Best Practices

• Token Security: Store the APY Token securely to prevent unauthorized access. Avoid exposing it in client-side code.
• Optimize API Calls: Minimize the number of API calls by caching results where possible to stay within usage limits.
• Error Logging: Implement logging for API responses to monitor usage, handle errors effectively, and capture response codes and error messages for debugging.

Support

For any issues or further assistance, refer to the APYHub documentation or contact their support team.

Conclusion

The APYHub API Connector for OutSystems (E-Commerce Quick Tools Category) equips developers with essential tools to enhance their e-commerce applications. From currency conversion to QR code generation, this connector simplifies the integration of key functionalities, allowing you to create more dynamic and user-friendly applications. With easy setup and a variety of actions, it is a valuable asset for any e-commerce project built in OutSystems.