Connect to Scrapfly Data in Aqua Data Studio

The CData JDBC Driver for Scrapfly integrates Scrapfly data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Scrapfly data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Scrapfly data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Scrapfly.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     The Scrapfly API uses API Key authentication. The API key is passed as the key query parameter on every request.

     Using API Key Authentication

     Your Scrapfly API key is required to create a connection. To obtain your API key:

     1. Log into your Scrapfly account at scrapfly.io.
     2. Navigate to Dashboard and select API Keys.
     3. Copy your API key (begins with scp-live- for production or scp-test- for the test environment).

     After obtaining your API key, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Scrapfly API key.

     Example connection string:

     Profile=C:\profiles\Scrapfly.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 Scrapfly 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.

     A typical JDBC URL is below:

     jdbc:api:Profile=C:\profiles\Scrapfly.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

   

Query Scrapfly Data

You can now query the tables exposed.