Query Reply.io Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Reply.io data. This article shows how to establish a connection to Reply.io data in DataGrip.

Create a New Driver Definition for Reply.io

The steps below describe how to create a new Data Source in DataGrip for Reply.io.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Reply.io Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Reply.io

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Reply.io Driver" to create a new Reply.io Data Source.
2. In the new window, configure the connection to Reply.io with a JDBC URL.

   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.

   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';
   

   
3. Set URL to the connection string, e.g.,

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

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Reply.io

To browse through the Reply.io entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT ,  FROM BillingInfo WHERE  = ''

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Reply.io data in DataGrip. Reach out to our Support Team if you have any questions.