Build Short.io-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData API Driver for JDBC, users can build Short.io-connected apps that work with live Short.io data. This article describes how to connect to Short.io from Servoy and build a simple web app to display and search Short.io data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Short.io data. When you issue complex SQL queries to Short.io, the driver pushes supported SQL operations, like filters and aggregations, directly to Short.io and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with Short.io data using native data types.

Connect to Short.io in Servoy Developer

To build Short.io-connected apps, you need to first create a data provider in Servoy Developer using the CData API Driver for JDBC.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.api.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

        Built-In Connection String Designer

        For assistance in constructing the JDBC URL, use the connection string designer built into the Short.io JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

        				java -jar cdata.jdbc.api.jar
        				

        Fill in the connection properties and copy the connection string to the clipboard.

        Using API Key Authentication

        Short.io uses API Key authentication. To obtain your API key:

        1. Log in to your Short.io account
        2. Navigate to Settings > Integrations & API > API
        3. Click Create API Key and copy your API key

        After obtaining the API key, you are ready to connect:

        • AuthScheme: Set this to APIKey.
        • APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

        Example connection string:

        Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
        

        Available Tables

        The Short.io profile provides access to the following tables:

        • Domains - Short.io domains associated with the authenticated account
        • Links - Short links for a domain
        • LinkExpand - Expand a short link by domain and path
        • LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
        • Folders - Link folders within a specific domain
        • LinkPermissions - Permission records for a specific link within a domain
        • CountryTargeting - Country-based redirect targeting rules for a specific short link
        • RegionTargeting - Region-based redirect targeting rules for a specific short link
        • Regions - List of available regions/states for a given country code
        • DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
        • LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link
        
      • Select the Driver class you just copied, for example, cdata.jdbc.api.APIDriver
   

Build a Short.io-Connected Web App

Once you have configured the connection to Short.io in the Servoy Developer resources, you are ready to build apps with access to live Short.io data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the Short.io "table" (e.g., from the Domains table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData API Driver for JDBC and start building Short.io-connected apps with Servoy. Reach out to our Support Team if you have any questions.