Overview

The APYHub API Connector (Data Validation Category) facilitates seamless integration with APYHub's comprehensive Data Validation APIs. This connector allows your OutSystems applications to leverage powerful validation services, ensuring the accuracy and reliability of critical data.

Key Features

• Aadhar Number Validation: Verify the validity of an Aadhar number.
• IBAN Number Validation: Validate International Bank Account Numbers (IBAN).
• IFSC Validation: Validate Indian Financial System Codes (IFSC).
• BIC/SWIFT Code Validation: Validate Bank Identifier Codes (BIC) and SWIFT codes.
• UK Postal Code Validation: Verify UK postal codes for accuracy.
• Academic Email Validation: Validate academic email addresses.
• Email DNS Validation: Validate email addresses by checking their DNS records.
• Indian Postal Code Validation: Validate Indian postal codes.
• VAT Number Validation: Validate VAT numbers.

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

Aadhar Number Validation

Validates an Aadhar number to ensure it is correct.

Parameters:

• aadharNumber (Text): The Aadhar number to be validated.

IBAN Number Validation

Validates an International Bank Account Number (IBAN).

Parameters:

• ibanNumber (Text): The IBAN to be validated.

IFSC Validation

Validates an Indian Financial System Code (IFSC).

Parameters:

• ifscCode (Text): The IFSC code to be validated.

BIC/SWIFT Code Validation

Validates a Bank Identifier Code (BIC) or SWIFT code.

Parameters:

• bicCode (Text): The BIC/SWIFT code to be validated.

UK Postal Code Validation

Validates a UK postal code for accuracy.

Parameters:

• postalCode (Text): The UK postal code to be validated.

Academic Email Validation

Validates an academic email address.

Parameters:

• email (Text): The academic email address to be validated.

Email DNS Validation

Validates an email address by checking its DNS records.

Parameters:

• email (Text): The email address to be validated.

Indian Postal Code Validation

Validates an Indian postal code.

Parameters:

• postalCode (Text): The Indian postal code to be validated.

VAT Number Validation

Validates a VAT number.

Parameters:

• vatNumber (Text): The VAT number to be validated.

Error Handling

• Invalid Token: Ensure that the APY Token is correctly configured. If invalid, request a new token from APYHub.
• API Limits: Keep track of your daily API usage to avoid exceeding the limit of 5 calls per day on the free version. 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 and avoid exposing it in client-side code to prevent unauthorized use.
• Error Logging: Implement logging for API responses to monitor usage and handle errors effectively. Capture response codes and error messages for debugging.
• Optimize Calls: Minimize the number of API calls by caching results where possible to stay within usage limits. Use appropriate data structures and algorithms to reduce redundant calls.
• Input Validation: Validate and preprocess input data to ensure it is well-formed and suitable for processing.

Support

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

Conclusion

The APYHub API Connector(Data Validation Category) is an essential tool for integrating robust data validation services into your applications. By leveraging APYHub's comprehensive Data Validation APIs, you can ensure the accuracy and reliability of critical data, enhancing the functionality and trustworthiness of your applications. With straightforward setup and configuration, this connector provides a seamless way to incorporate advanced validation capabilities into your OutSystems projects.