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 Ruby


Connect to Invoiced data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

The CData ODBC Driver for Invoiced makes it easy to integrate connectivity to live Invoiced data in Ruby. This article shows how to create a simple Ruby app that connects to Invoiced data, executes a query, and displays the results.

Create an ODBC Connection to Invoiced Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi gem install dbd-odbc gem install ruby-odbc

Create a Ruby 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:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData API Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Name FROM Invoices WHERE Paid = 'false'") #display the names of the columns resultSet.column_names.each do |name| print name, "\t" end puts #display the results while row = resultSet.fetch do (0..resultSet.column_names.size - 1).each do |n| print row[n], "\t" end puts end resultSet.finish #close the connection cnxn.disconnect if cnxn

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

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