Learn more
 

Ready to get started?

Connect to live data from Invoiced with the API Driver

Connect to Invoiced

In this article

Related articles

Connect to Invoiced Data in JRuby


Create a simple JRuby app with access to live Invoiced data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Invoiced makes it easy to integrate connectivity to live Invoiced data in JRuby. This article shows how to create a simple JRuby app that connects to Invoiced data, executes a query, and displays the results.

Configure a JDBC Connection to Invoiced Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Invoiced\lib).

JRuby natively supports JDBC, so you can easily connect to Invoiced and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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

Invoiced API Profile Settings

In order to authenticate to Invoiced, you'll need to provide your API Key. An API key can be obtained by signing in to your account, and then going to Settings > Developers > API Keys. Set the API Key in the ProfileSettings property to connect.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Invoiced 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 JDBC connection string for Invoiced:

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

Create a JRuby App with Connectivity to Invoiced Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Invoiced 2018/lib/cdata.jdbc.api.jar' url = "jdbc:api:Profile=C:\profiles\Invoiced.apip;ProfileSettings='APIKey=your_api_key';" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, Name FROM Invoices") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Invoiced data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to Invoiced allows you to quickly and easily incorporate Invoiced data into your own JRuby applications. Download a free trial today!