Connect to Rebilly Data in RazorSQL

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Rebilly from wizards and query Rebilly data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Rebilly 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 Rebilly using wizards in RazorSQL.

Create a JDBC Data Source for Rebilly 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.

      Start by setting the Profile connection property to the location of the Rebilly Profile on disk (e.g. C:\profiles\Rebilly.apip). Next, set the ProfileSettings connection property to the connection string for Rebilly (see below).

      Rebilly API Profile Settings

      Generate an API Key in Rebilly by navigating to Automations > Integrations > Custom Integrations > API Keys and selecting Secret as the type.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Rebilly 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\Rebilly.apip;ProfileSettings='APIKey=your_api_key';

Query Rebilly 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.

Ready to get started?

Connect to live data from Rebilly with the API Driver

Connect to Rebilly