Access Paylocity Data in PHP through Connect Server

You can use CData Connect Server to access Paylocity 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 Paylocity and connect to Paylocity 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 Paylocity, allowing you to easily build reports from live Paylocity 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 Paylocity, leveraging server-side processing to quickly return the requested Paylocity data.

Create a Virtual SQL Server Database for Paylocity 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 "Paylocity" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Paylocity.

   Set the following to establish a connection to Paylocity:

   • RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.

     This property is required for executing Insert and Update statements, and it is not required if the feature is disabled.

   • UseSandbox: Set to true if you are using sandbox account.
   • CustomFieldsCategory: Set this to the Customfields category. This is required when IncludeCustomFields is set to true. The default value for this property is PayrollAndHR.
   • Key: The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. It is the key used to encrypt the content.

     Paylocity will decrypt the AES key using RSA decryption.
     It is an optional property if the IV value not provided, The driver will generate a key internally.

   • IV: The AES IV (base 64 encoded) used when encrypting the content. It is an optional property if the Key value not provided, The driver will generate an IV internally.

   Connect Using OAuth Authentication

   You must use OAuth to authenticate with Paylocity. OAuth requires the authenticating user to interact with Paylocity using the browser. For more information, refer to the OAuth section in the Help documentation.

   The Pay Entry API

   The Pay Entry API is completely separate from the rest of the Paylocity API. It uses a separate Client ID and Secret, and must be explicitly requested from Paylocity for access to be granted for an account. The Pay Entry API allows you to automatically submit payroll information for individual employees, and little else. Due to the extremely limited nature of what is offered by the Pay Entry API, we have elected not to give it a separate schema, but it may be enabled via the UsePayEntryAPI connection property.

   Please be aware that when setting UsePayEntryAPI to true, you may only use the CreatePayEntryImportBatch & MergePayEntryImportBatchgtable stored procedures, the InputTimeEntry table, and the OAuth stored procedures. Attempts to use other features of the product will result in an error. You must also store your OAuthAccessToken separately, which often means setting a different OAuthSettingsLocation when using this connection property.

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 Paylocity 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 Paylocity.
• 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"=>"Paylocity1", "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=Paylocity1", $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, Employee. 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 FirstName, LastName FROM Employee WHERE EmployeeId = '1234'");
while($row = $result->fetch_assoc()) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br>"; 
  }
}
$sqlsrv_connect->close();

PDO

$result = $pdo->query("SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'");
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 Paylocity Data using PHP

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

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