APYHub API Connector for OutSystems (Data Extraction Category)

Overview

The APYHub API Connector for OutSystems provides seamless integration with APYHub's Data Extraction APIs, enabling advanced data processing and extraction functionalities within your OutSystems applications. This connector includes a comprehensive suite of server actions to enhance your application's data handling capabilities.

Key Features

This connector supports the following server actions from the Data Extraction category:

1. Analyze Keywords: Extract and analyze keywords from text.
2. Convert Speech to Text: Transcribe spoken language into written text.
3. Convert Text to Speech: Generate spoken audio from text input.
4. Detect Language: Identify the language of a given text.
5. Extract Image Metadata: Retrieve metadata information from images.
6. Extract Text from PDF: Extract text content from PDF files.
7. Extract Text from Word: Extract text content from Word documents.
8. Extract Text from Webpage: Extract text content from web pages.
9. Extract User Agent: Extract and interpret user agent strings.
10. Fuzzy Text Search: Perform fuzzy searches on text data.
11. Generate Link Preview: Generate a preview for a given URL.
12. Readability Score: Calculate the readability score of text.
13. Readability Score for Documents: Calculate the readability score of documents.
14. SERP Rank Checker: Check the rank of a URL in search engine results pages.
15. Translate Documents: Translate documents into different languages.
16. Unarchive Files: Unarchive files from various archive formats.
17. Unarchive Secured Files: Unarchive password-protected files (password input parameter required).

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

Analyze Keywords

Extract and analyze keywords from a given text.

Parameters:

• URL (Text): The URL from which to extract keywords.

Convert Speech to Text

Transcribe spoken language into written text.

Parameters:

• audioFile (Binary): The audio file to be transcribed.

Convert Text to Speech

Generate spoken audio from text input.

Supported file formats are pdf, doc, docx, png, jpg, jpeg, bmp, tiff, xlsx, pptx, html, and xml

Parameters:

• File (Binary): Content to be converted to speech.

Detect Language

Identify the language of a given text.

Parameters:

• text (Text): The text whose language needs to be detected.

Extract Image Metadata

Retrieve metadata information from an image.

Parameters:

• imageFile (Binary): The image file from which to extract metadata.

Extract Text from PDF

Extract text content from PDF files.

Parameters:

• pdfFile (Binary): The PDF file from which to extract text.

Extract Text from Word

Extract text content from Word documents.

Parameters:

• wordFile (Binary): The Word document from which to extract text.

Extract Text from Webpage

Extract text content from web pages.

Parameters:

• url (Text): The URL of the webpage to extract text from.

Extract User Agent

Extract and interpret user agent strings.

Parameters:

• userAgent (Text): The user agent string to be interpreted.

Fuzzy Text Search

Perform fuzzy searches on text data.

Parameters:

• text (Text): The text to search within.
• query (Text): The search query.

Generate Link Preview

Generate a preview for a given URL.

Parameters:

• url (Text): The URL to generate a preview for.

Readability Score

Calculate the readability score of text.

Parameters:

• text (Text): The text to calculate readability for.

Readability Score for Documents

Calculate the readability score of documents.

Parameters:

• document (Binary): The document file to calculate readability for.

SERP Rank Checker

Check the rank of a URL in search engine results pages.

Parameters:

• url (Text): The URL to check the rank for.
• keywords (Text): The keywords to check the rank against.

Translate Documents

Translate documents into different languages.

Supported Languages: Arabic (ar), Assamese (as), Bengali (bn), Belarusian (be), Bulgarian (bg), Chinese (Simplified) (zh-Hans), Chinese (Traditional) (zh-Hant), Greek (el), Gujarati (gu), Hebrew (he), Hindi (hi), Japanese (ja), Kannada (kn), Kazakh (kk), Korean (ko), Kyrgyz (ky), Macedonian (mk), Malayalam (ml), Marathi (mr), Mongolian (mn), Odia (or), Persian (fa), Punjabi (pa), Russian (ru), Serbian (Cyrillic) (sr-Cyrl), Sindhi (sd), Sinhala (si), Tajik (tg), Tamil (ta), Tatar (tt), Telugu (te), Thai (th), Ukrainian (uk), Urdu (ur)

Parameters:

• document (Binary): The document to be translated.
• Language (Text): Desired translation language. Should be specified in ISO 639-1 format.

Unarchive Files

Unarchive files from various archive formats.

Parameters:

• archiveFile (Binary): The archive file to be unarchived.

Unarchive Secured Files

Unarchive password-protected files.

Parameters:

• archiveFile (Binary): The archive file to be unarchived.
• password (Text): The password for the archive.

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.