Connect to Reply.io Data in RazorSQL

The CData JDBC Driver for Reply.io enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Reply.io using wizards in RazorSQL.

Create a JDBC Data Source for Reply.io Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     The Reply.io API uses API Key authentication via the x-api-key request header.

     Using API Key Authentication

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

     1. Log into your Reply.io account.
     2. Click your profile icon and select Settings.
     3. Navigate to the API section.
     4. Copy your API Key.

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

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Reply.io API key.
     • UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.

     Example connection string:

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

     

     A typical JDBC URL is the following:

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

Query Reply.io Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.