Ready to get started?

Learn more or sign up for a free trial:

CData Connect Server

Access Harvest Data in PHP through Connect Server



Connect to Harvest through the standard SQL Server libraries in PHP.

You can use CData Connect Server to access Harvest data from SQL Server clients, without needing to perform an ETL or cache data. Follow the steps below to create a virtual SQL Server database for Harvest and connect to Harvest data in real time through PHP's standard SQL Server interface, i.e. sqlsrv_connect.

CData Connect Server provides a pure SQL Server interface for Harvest, allowing you to easily build reports from live Harvest data in PHP — without replicating the data to a natively supported database. As you build visualizations, PHP generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Server pushes all supported SQL operations (filters, JOINs, etc) directly to Harvest, leveraging server-side processing to quickly return the requested Harvest data.

Create a Virtual SQL Server Database for Harvest Data

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Server and click Connections.
  2. Select "Harvest" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Harvest.

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

    Harvest API Profile Settings

    To authenticate to Harvest, you can use either Token authentication or the OAuth standard. Use Basic authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

    Using Token Authentication

    To use Token Authentication, set the APIKey to your Harvest Personal Access Token in the ProfileSettings connection property. In addition to APIKey, set your AccountId in ProfileSettings to connect.

    Using OAuth Authentication

    First, register an OAuth2 application with Harvest. The application can be created from the "Developers" section of Harvest ID.

    After setting the following connection properties, you are ready to connect:

    • ProfileSettings: Set your AccountId in ProfileSettings.
    • AuthScheme: Set this to OAuth.
    • OAuthClientId: Set this to the client ID that you specified in your app settings.
    • OAuthClientSecret: Set this to the client secret that you specified in your app settings.
    • CallbackURL: Set this to the Redirect URI that you specified in your app settings.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage how the driver obtains and refreshes the OAuthAccessToken.
  4. Click Save Changes
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Harvest data from PHP.

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual SQL Server database:

  • Server name/Host: Specify the remote host location where the service is running.
  • Username: Specify the username for a user you authorized in Connect Server.
  • Password: Specify the password for the authorized user account.
  • Database Name: Specify the name of the virtual database you created for Harvest.
  • Port: Specify the port the service is running on, port 1433 in this example.

sqlsrv_connect

<?php
$serverName = "connect_server_url, 1433"; //Connect Server Address, portNumber (default is 1433)
$connectionInfo = array( "Database"=>"API1", "UID"=>"userName", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);

if( $conn ) {
     echo "Connection established.<br>";
}else{
     echo "Connection could not be established.<br>";
     die( print_r( sqlsrv_errors(), true));
}
?>

PDO

<?php
<?php
$user = my_connect_user
$pass = my_connect_pass

$pdo = new PDO("sqlsrv:Server=connect_server_url,1433;Database=API1", $user , $pass);

?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

  1. Query the table; for example, Invoices. The results will be stored as an associative array in the $result object.
  2. Iterate over each row and column, printing the values to display in the PHP page.
  3. Close the connection.

sqlsrv_connect

$result = $sqlsrv_connect->query("SELECT Id, ClientName FROM Invoices WHERE State = 'open'");
while($row = $result->fetch_assoc()) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$sqlsrv_connect->close();

PDO

$result = $pdo->query("SELECT Id, ClientName FROM Invoices WHERE State = 'open'");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$result = null;
$pdo = null;

SQL Server Access to Harvest Data using PHP

You have retrieved live Harvest Data using PHP. Now, you can easily access data sources and more — all without replicating Harvest data.

To get SQL data access to 200+ SaaS, Big Data, and NoSQL sources directly from your applications, try CData Connect Server.