Manage Reply.io Data in DBArtisan as a JDBC Source

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

Integrate Reply.io Data into DBArtisan Projects

Follow the steps below to register Reply.io 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 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.

   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Reply.io data. Reply.io entities are displayed in the Datasource Explorer.

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