Manage Scrapfly Data in DBArtisan as a JDBC Source

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to create a JDBC data source for Scrapfly.

The CData JDBC Driver for Scrapfly seamlessly integrates Scrapfly data into database management tools like DBArtisan by enabling you to access Scrapfly data as a database. This article shows how to create a JDBC source for Scrapfly in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Scrapfly Data into DBArtisan Projects

Follow the steps below to register Scrapfly data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    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.

    Below is a typical connection string:

    jdbc:api:Profile=C:\profiles\Scrapfly.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
  6. Finish the wizard to connect to Scrapfly data. Scrapfly entities are displayed in the Datasource Explorer.

You can now work with Scrapfly data as you work with any other database. See the driver help documentation for more information on the queries supported by the Scrapfly API.

Ready to get started?

Connect to live data from Scrapfly with the API Driver

Connect to Scrapfly