xebia-apyhub-standard-data
Service icon

Xebia_APYHub Standard Data

Stable version 1.0.1 (Compatible with OutSystems 11)
Uploaded
 on 27 August 2024
 by 
Rupesh Wani (https://www.outsystems.com/profile/18btdm3t1f/)
0.0
 (0 ratings)
xebia-apyhub-standard-data

Xebia_APYHub Standard Data

Documentation
1.0.1

Overview

The APYHub API Connector (Standard Data Category) for OutSystems is a versatile and powerful tool that allows developers to seamlessly integrate standard data services provided by APYHub into their applications. This connector offers a range of server actions that provide essential geographical and financial information, making it an invaluable resource for applications that require up-to-date and accurate data.

Key Features

  • Seamless Integration: Easily interact with APYHub APIs directly within your OutSystems applications.
  • Comprehensive Data Access: Retrieve global data, including country details, time zones, and currencies.
  • User-Friendly: Simplifies data retrieval, ensuring your application has access to crucial information without complex configurations.
  • API Usage Limits: The free version of APYHub allows for 5 API calls per day. To maximize the use of this component, users must obtain an APY Token from the APYHub official site.


Server Actions

The connector includes the following server actions:

  1. Get Countries List

    • Description: Retrieves a list of all countries. This can be used to populate dropdowns, or for any application requiring global country data.
    • Parameters: None.
    • Output: A list of countries with essential details like country code, name, and region.
  2. Get Specific Country Information

    • Description: Fetches detailed information about a specific country by providing the country code or name. This action is useful for applications needing in-depth country data.
    • Parameters:
      • CountryCode or CountryName: The code or name of the country to retrieve information for.
    • Output: Comprehensive details about the specified country, including population, area, capital, and more.
  3. Get Time Zones

    • Description: Retrieves a list of time zones across the globe. This is essential for applications dealing with international users or scheduling events across different regions.
    • Parameters: None.
    • Output: A list of time zones, including the time zone name, offset, and region.
  4. Get Currencies

    • Description: Provides information about global currencies, including currency codes, names, and symbols. Ideal for financial applications or any system that deals with multiple currencies.
    • Parameters: None.
    • Output: A list of currencies with relevant details.

Getting Started

To start using this connector in your OutSystems application:

  1. Obtain APY Token: Visit the APYHub official site and register for an account to receive your APY Token.
  2. Install the Connector: Download and install the APYHub API Connector (Standard Data Category) from the OutSystems Forge into your environment.
  3. Configure the Token: In your OutSystems environment, configure the connector by entering your APY Token in the appropriate settings.
  4. Use Server Actions: Integrate the provided server actions into your application logic to retrieve the required data.

API Call Limits

Please note that the free version of APYHub allows for a maximum of 5 API calls per day. If your application requires more frequent data access, consider upgrading your APYHub plan.

Support

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

Conclusion

The APYHub API Connector (Standard Data Category) is an essential tool for developers who need to integrate reliable and up-to-date geographical and financial data into their OutSystems applications. With easy-to-use server actions and a straightforward setup process, this connector enhances the functionality of your application while ensuring access to crucial data.


1.0.0

Overview

The APYHub API Connector (Standard Data Category) for OutSystems is a versatile and powerful tool that allows developers to seamlessly integrate standard data services provided by APYHub into their applications. This connector offers a range of server actions that provide essential geographical and financial information, making it an invaluable resource for applications that require up-to-date and accurate data.

Key Features

  • Seamless Integration: Easily interact with APYHub APIs directly within your OutSystems applications.
  • Comprehensive Data Access: Retrieve global data, including country details, time zones, and currencies.
  • User-Friendly: Simplifies data retrieval, ensuring your application has access to crucial information without complex configurations.
  • API Usage Limits: The free version of APYHub allows for 5 API calls per day. To maximize the use of this component, users must obtain an APY Token from the APYHub official site.


Server Actions

The connector includes the following server actions:

  1. Get Countries List

    • Description: Retrieves a list of all countries. This can be used to populate dropdowns, or for any application requiring global country data.
    • Parameters: None.
    • Output: A list of countries with essential details like country code, name, and region.
  2. Get Specific Country Information

    • Description: Fetches detailed information about a specific country by providing the country code or name. This action is useful for applications needing in-depth country data.
    • Parameters:
      • CountryCode or CountryName: The code or name of the country to retrieve information for.
    • Output: Comprehensive details about the specified country, including population, area, capital, and more.
  3. Get Time Zones

    • Description: Retrieves a list of time zones across the globe. This is essential for applications dealing with international users or scheduling events across different regions.
    • Parameters: None.
    • Output: A list of time zones, including the time zone name, offset, and region.
  4. Get Currencies

    • Description: Provides information about global currencies, including currency codes, names, and symbols. Ideal for financial applications or any system that deals with multiple currencies.
    • Parameters: None.
    • Output: A list of currencies with relevant details.

Getting Started

To start using this connector in your OutSystems application:

  1. Obtain APY Token: Visit the APYHub official site and register for an account to receive your APY Token.
  2. Install the Connector: Download and install the APYHub API Connector (Standard Data Category) from the OutSystems Forge into your environment.
  3. Configure the Token: In your OutSystems environment, configure the connector by entering your APY Token in the appropriate settings.
  4. Use Server Actions: Integrate the provided server actions into your application logic to retrieve the required data.

API Call Limits

Please note that the free version of APYHub allows for a maximum of 5 API calls per day. If your application requires more frequent data access, consider upgrading your APYHub plan.

Support

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

Conclusion

The APYHub API Connector (Standard Data Category) is an essential tool for developers who need to integrate reliable and up-to-date geographical and financial data into their OutSystems applications. With easy-to-use server actions and a straightforward setup process, this connector enhances the functionality of your application while ensuring access to crucial data.