TimeTrex/api/json/api_client_example_stand_alone.php

594 lines
17 KiB
PHP

<?php
/*
Global variables
*/
$TIMETREX_URL = 'https://demo.timetrex.com/next-release/api/json/api.php';
$TIMETREX_API_KEY = ''; //API SESSION KEY to use for all API requests, obtained immediately below.
//Build URL given a Class and Method to call.
//Format is: http://demo.timetrex.com/api/json/api.php?Class=<CLASS>&Method=<METHOD>&SessionID=<SessionID>
function buildURL( $class, $method ) {
global $TIMETREX_URL;
$url = $TIMETREX_URL . '?Class=' . $class . '&Method=' . $method;
return $url;
}
//Handle complex result.
function handleResult( $result, $raw = false ) {
if ( is_array( $result ) && isset( $result['api_retval'] ) ) {
if ( $raw === true ) {
return $result;
} else {
if ( $result['api_retval'] === false ) {
//Display any error messages that might be returned.
$output[] = ' Returned:';
$output[] = ( $result['api_retval'] === true ) ? ' IsValid: YES' : ' IsValid: NO';
if ( $result['api_retval'] === true ) {
$output[] = ' Return Value: ' . $result['api_retval'];
} else {
$output[] = ' Code: ' . $result['api_details']['code'];
$output[] = ' Description: ' . $result['api_details']['description'];
$output[] = ' Details: ';
$details = $result['api_details']['details'];
if ( is_array( $details ) ) {
foreach ( $details as $row => $detail ) {
$output[] = ' Row: ' . $row;
foreach ( $detail as $field => $msgs ) {
$output[] = ' --Field: ' . $field;
foreach ( $msgs as $key => $msg ) {
$output[] = ' ----Message: ' . $msg;
}
}
}
}
}
$output[] = '==============================================================';
$output[] = '';
echo implode( "\n", $output );
}
return $result['api_retval'];
}
}
return $result;
}
//Post data (array of arguments) to URL
function postToURL( $url, $data = null, $raw_result = false ) {
$curl_connection = curl_init();
curl_setopt( $curl_connection, CURLOPT_URL, $url );
curl_setopt( $curl_connection, CURLOPT_REFERER, $url ); //**IMPORTANT: Referer should always be sent to avoid requests being rejected due to CSRF security checks.
curl_setopt( $curl_connection, CURLOPT_CONNECTTIMEOUT, 600 );
curl_setopt( $curl_connection, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $curl_connection, CURLOPT_SSL_VERIFYPEER, false );
curl_setopt( $curl_connection, CURLOPT_FOLLOWLOCATION, 1 );
global $TIMETREX_API_KEY;
curl_setopt( $curl_connection, CURLOPT_HTTPHEADER, [ 'Cookie: SessionID='. $TIMETREX_API_KEY ] ); //Send API Key as a cookie.
//When sending JSON data to POST, it must be sent as: json=<JSON DATA>
//<JSON DATA> should be an associative array with the first level being the number of arguments, where each argument can be of mixed type. ie:
// array(
// 0 => <ARG1>,
// 1 => <ARG2>,
// 2 => <ARG3>,
// ...
// )
echo "==============================================================\n";
echo "Posting data to URL: " . $url . "\n";
if ( $data !== null ) {
$post_data = 'json=' . urlencode( json_encode( $data ) );
curl_setopt( $curl_connection, CURLOPT_POSTFIELDS, $post_data );
echo " POST Data: " . $post_data . "\n";
}
echo "--------------------------------------------------------------\n";
$result = curl_exec( $curl_connection );
curl_close( $curl_connection );
return handleResult( json_decode( $result, true ), $raw_result );
}
if ( !isset( $TIMETREX_API_KEY ) || $TIMETREX_API_KEY == '' ) {
//IMPORTANT: When passing separate arguments to a function the order must be correctly maintained.
// So when passing named key => value pairs always ensure that the order is preserved when the data is JSON encoded.
$arguments = [ 'user_name' => 'demoadmin1', 'password' => 'demo' ];
// Alternatively you can send integer key => value pairs, similar to the below which may help to ensure order is maintained.
//$arguments = [ $TIMETREX_USERNAME, $TIMETREX_PASSWORD ]; //Or
//$arguments = [ 0 => $TIMETREX_USERNAME, 1 => $TIMETREX_PASSWORD ];
$TIMETREX_API_KEY = postToURL( buildURL( 'APIAuthentication', 'registerAPIKey' ), $arguments );
if ( $TIMETREX_API_KEY == false ) {
echo "Login Failed, please check username/password or URL to ensure it is correct!<br>\nIf multifactor authentication is enabled, login to TimeTrex and go to Profile -> Security / Passwords, More (...) -> Register API Key.<br>\n";
exit;
} else {
echo "Permanent API KEY SESSION registered, you may now define this in your code for all subsequent API calls:<br>\n";
echo "\$TIMETREX_API_KEY = '" . $TIMETREX_API_KEY . "'<br>\n";
exit;
}
}
//
//Get data for two employees by user_name or primary key/ID.
// - Many other filter methods can be used, such as branch, department, province, state, etc...
//
$arguments = [
'filter_data' => [
//'id' => array('11e817cb-7dcc-7130-b939-5431e6810149','11e817cb-8385-8e50-97f3-5431e6810149')
'user_name' => 'john.doe1',
],
];
$user_data = postToURL( buildURL( 'APIUser', 'getUser' ), [ $arguments ] );
//var_dump( $user_data );
/* //Example returned data:
array(2) {
[0]=>
array(98) {
["id"]=>
string(36) "11e7fa4c-f3fd-2d90-b320-21ea65522ba3"
["company_id"]=>
string(36) "11e7fa4c-e7b5-37d0-87c6-21ea65522ba3"
["company"]=>
string(15) "ABC Company (1)"
["legal_entity_id"]=>
string(36) "11e7fa4c-e825-8050-8e4a-21ea65522ba3"
["legal_name"]=>
string(18) "ACME USA East Inc."
["status_id"]=>
string(2) "10"
["status"]=>
string(6) "Active"
["group_id"]=>
string(36) "11e7fa4c-e980-6090-adff-21ea65522ba3"
["user_group"]=>
string(9) "Corporate"
["ethnic_group_id"]=>
string(36) "11e7fa4c-e9a8-2880-9b0d-21ea65522ba3"
["ethnic_group"]=>
string(5) "White"
["user_name"]=>
string(14) "tristen.braun1"
["phone_id"]=>
string(0) ""
["employee_number"]=>
int(13)
["title_id"]=>
string(36) "11e7fa4c-e98e-4fb0-8cc1-21ea65522ba3"
["title"]=>
string(9) "Carpenter"
["default_branch_id"]=>
string(36) "11e7fa4c-e857-84b0-9ebc-21ea65522ba3"
["default_branch"]=>
string(8) "New York"
["default_branch_manual_id"]=>
string(1) "1"
["default_department_id"]=>
string(36) "11e7fa4c-e870-7660-b2a1-21ea65522ba3"
["default_department"]=>
string(12) "Construction"
["default_department_manual_id"]=>
string(1) "2"
["default_job_id"]=>
string(36) "00000000-0000-0000-0000-000000000000"
["default_job"]=>
bool(false)
["default_job_manual_id"]=>
bool(false)
["default_job_item_id"]=>
string(36) "00000000-0000-0000-0000-000000000000"
["default_job_item"]=>
bool(false)
["default_job_item_manual_id"]=>
bool(false)
["permission_control_id"]=>
string(36) "11e7fa4c-e7bb-a9b0-a40e-21ea65522ba3"
["permission_control"]=>
string(31) "Regular Employee (Punch In/Out)"
["pay_period_schedule_id"]=>
string(36) "11e7fa4d-0208-8360-a212-21ea65522ba3"
["pay_period_schedule"]=>
string(9) "Bi-Weekly"
["policy_group_id"]=>
string(36) "11e7fa4d-025e-93e0-bc8b-21ea65522ba3"
["policy_group"]=>
string(7) "Default"
["first_name"]=>
string(7) "Tristen"
["first_name_metaphone"]=>
string(5) "TRSTN"
["middle_name"]=>
bool(false)
["last_name"]=>
string(6) "BraunD"
["last_name_metaphone"]=>
string(4) "BRNT"
["full_name"]=>
string(15) "BraunD, Tristen"
["second_last_name"]=>
bool(false)
["sex_id"]=>
string(2) "20"
["sex"]=>
string(6) "Female"
["address1"]=>
string(13) "9289 Ethel St"
["address2"]=>
string(9) "Unit #560"
["city"]=>
string(8) "New York"
["country"]=>
string(2) "US"
["province"]=>
string(2) "NY"
["postal_code"]=>
string(5) "00521"
["work_phone"]=>
string(12) "417-268-2473"
["work_phone_ext"]=>
string(3) "204"
["home_phone"]=>
string(12) "567-570-8135"
["mobile_phone"]=>
bool(false)
["fax_phone"]=>
bool(false)
["home_email"]=>
bool(false)
["home_email_is_valid"]=>
bool(true)
["home_email_is_valid_key"]=>
bool(false)
["home_email_is_valid_date"]=>
bool(false)
["feedback_rating"]=>
bool(false)
["work_email"]=>
string(30) "tristen.braun1@abc-company.com"
["work_email_is_valid"]=>
bool(true)
["work_email_is_valid_key"]=>
bool(false)
["work_email_is_valid_date"]=>
bool(false)
["birth_date"]=>
string(9) "01-Jun-88"
["birth_date_age"]=>
int(29)
["hire_date"]=>
string(9) "26-May-13"
["hire_date_age"]=>
string(4) "4.74"
["termination_date"]=>
NULL
["currency_id"]=>
string(36) "11e7fa4c-e80b-8110-97b4-21ea65522ba3"
["currency"]=>
string(9) "US Dollar"
["currency_rate"]=>
string(12) "1.0000000000"
["sin"]=>
string(9) "401240815"
["note"]=>
bool(false)
["longitude"]=>
bool(false)
["latitude"]=>
bool(false)
["tag"]=>
string(0) ""
["last_login_date"]=>
NULL
["max_punch_time_stamp"]=>
NULL
["deleted"]=>
bool(false)
["is_owner"]=>
bool(false)
["is_child"]=>
bool(true)
["created_by_id"]=>
string(36) "11e7fa4c-e9e5-4bb0-90f9-21ea65522ba3"
["created_by"]=>
string(18) "Mr. AdministratorC"
["created_date"]=>
string(17) "15-Jan-18 3:36 PM"
["updated_by_id"]=>
string(36) "11e7fa4c-e9e5-4bb0-90f9-21ea65522ba3"
["updated_by"]=>
string(18) "Mr. AdministratorC"
["updated_date"]=>
string(17) "15-Feb-18 3:04 PM"
}
[1]=>
array(98) {
["id"]=>
string(36) "11e7fa4c-f8c2-f040-8ad8-21ea65522ba3"
["company_id"]=>
string(36) "11e7fa4c-e7b5-37d0-87c6-21ea65522ba3"
["company"]=>
string(15) "ABC Company (1)"
["legal_entity_id"]=>
string(36) "11e7fa4c-e833-0860-9978-21ea65522ba3"
["legal_name"]=>
string(18) "ACME USA West Inc."
["status_id"]=>
string(2) "10"
["status"]=>
string(6) "Active"
["group_id"]=>
string(36) "11e7fa4c-e985-7df0-85ed-21ea65522ba3"
["user_group"]=>
string(15) "Human Resources"
["ethnic_group_id"]=>
string(36) "11e7fa4c-e9b2-5420-8bd5-21ea65522ba3"
["ethnic_group"]=>
string(6) "Indian"
["user_name"]=>
string(9) "jane.doe1"
["phone_id"]=>
string(5) "12341"
["employee_number"]=>
int(20)
["title_id"]=>
string(36) "11e7fa4c-e993-9320-8ba8-21ea65522ba3"
["title"]=>
string(15) "General Laborer"
["default_branch_id"]=>
string(36) "11e7fa4c-e85c-3ba0-b7aa-21ea65522ba3"
["default_branch"]=>
string(7) "Seattle"
["default_branch_manual_id"]=>
string(1) "2"
["default_department_id"]=>
string(36) "11e7fa4c-e870-7660-b2a1-21ea65522ba3"
["default_department"]=>
string(12) "Construction"
["default_department_manual_id"]=>
string(1) "2"
["default_job_id"]=>
string(36) "00000000-0000-0000-0000-000000000000"
["default_job"]=>
bool(false)
["default_job_manual_id"]=>
bool(false)
["default_job_item_id"]=>
string(36) "00000000-0000-0000-0000-000000000000"
["default_job_item"]=>
bool(false)
["default_job_item_manual_id"]=>
bool(false)
["permission_control_id"]=>
string(36) "11e7fa4c-e7bb-a9b0-a40e-21ea65522ba3"
["permission_control"]=>
string(31) "Regular Employee (Punch In/Out)"
["pay_period_schedule_id"]=>
string(36) "11e7fa4d-0208-8360-a212-21ea65522ba3"
["pay_period_schedule"]=>
string(9) "Bi-Weekly"
["policy_group_id"]=>
string(36) "11e7fa4d-025e-93e0-bc8b-21ea65522ba3"
["policy_group"]=>
string(7) "Default"
["first_name"]=>
string(4) "Jane"
["first_name_metaphone"]=>
string(2) "JN"
["middle_name"]=>
bool(false)
["last_name"]=>
string(3) "Doe"
["last_name_metaphone"]=>
string(1) "T"
["full_name"]=>
string(9) "Doe, Jane"
["second_last_name"]=>
bool(false)
["sex_id"]=>
string(2) "20"
["sex"]=>
string(6) "Female"
["address1"]=>
string(15) "4936 Ontario St"
["address2"]=>
string(9) "Unit #993"
["city"]=>
string(7) "Seattle"
["country"]=>
string(2) "US"
["province"]=>
string(2) "WA"
["postal_code"]=>
string(5) "98867"
["work_phone"]=>
string(12) "558-301-1737"
["work_phone_ext"]=>
string(3) "308"
["home_phone"]=>
string(12) "464-312-4450"
["mobile_phone"]=>
bool(false)
["fax_phone"]=>
bool(false)
["home_email"]=>
bool(false)
["home_email_is_valid"]=>
bool(true)
["home_email_is_valid_key"]=>
bool(false)
["home_email_is_valid_date"]=>
bool(false)
["feedback_rating"]=>
bool(false)
["work_email"]=>
string(25) "jane.doe1@abc-company.com"
["work_email_is_valid"]=>
bool(true)
["work_email_is_valid_key"]=>
bool(false)
["work_email_is_valid_date"]=>
bool(false)
["birth_date"]=>
string(9) "24-Dec-70"
["birth_date_age"]=>
int(47)
["hire_date"]=>
string(9) "15-Sep-09"
["hire_date_age"]=>
string(4) "8.44"
["termination_date"]=>
NULL
["currency_id"]=>
string(36) "11e7fa4c-e813-c120-9c2c-21ea65522ba3"
["currency"]=>
string(15) "Canadian Dollar"
["currency_rate"]=>
string(12) "1.2000000000"
["sin"]=>
string(9) "695238280"
["note"]=>
bool(false)
["longitude"]=>
bool(false)
["latitude"]=>
bool(false)
["tag"]=>
string(5) "check"
["last_login_date"]=>
NULL
["max_punch_time_stamp"]=>
NULL
["deleted"]=>
bool(false)
["is_owner"]=>
bool(false)
["is_child"]=>
bool(true)
["created_by_id"]=>
string(36) "11e7fa4c-e9e5-4bb0-90f9-21ea65522ba3"
["created_by"]=>
string(18) "Mr. AdministratorC"
["created_date"]=>
string(17) "15-Jan-18 3:36 PM"
["updated_by_id"]=>
string(36) "11e7fa4c-e9e5-4bb0-90f9-21ea65522ba3"
["updated_by"]=>
string(18) "Mr. AdministratorC"
["updated_date"]=>
string(17) "15-Feb-18 3:04 PM"
}
}
*/
//
//Update data for the second employee, mark their status as Terminated and update Termination Date
//
if ( isset( $user_data[1] ) ) {
$user_data[1]['status_id'] = 20; //Terminated
$user_data[1]['termination_date'] = '02-Jan-18';
$result = postToURL( buildURL( 'APIUser', 'setUser' ), [ $user_data[1] ] );
if ( $result === true ) {
echo "Employee data saved successfully.<br>\n";
} else {
echo "Employee save failed.<br>\n";
print $result; //Show error messages
}
}
//
//Update employee record in a single operation. Several records can be updated in a single operation as well.
//
$user_data = [
'id' => $user_data[1]['id'], //UUID: 11e7fa4c-f8c2-f040-8ad8-21ea65522ba3
'termination_date' => '02-Jan-18',
];
$result = postToURL( buildURL( 'APIUser', 'setUser' ), [ $user_data ] );
if ( $result === true ) {
echo "Employee data saved successfully.<br>\n";
} else {
echo "Employee save failed.<br>\n";
print $result; //Show error messages
}
//
//Get new hire defaults so we pull data from that rather than have to manually specify it each time.
//
$new_hire_defaults = postToURL( buildURL( 'APIUserDefault', 'getUserDefault' ), [] )[0];
//
//Add new employee, several new employees can be added in a single operation as well.
//
$user_data = [
'status_id' => 10, //Active
'first_name' => 'Michael',
'last_name' => 'Jackson',
'employee_number' => rand( 10000, 99999 ),
'user_name' => 'mjackson_' . rand( 10000, 99999 ),
'password' => 'whiteglove123',
'hire_date' => '01-Oct-09',
'currency_id' => $new_hire_defaults['currency_id'],
];
$result = postToURL( buildURL( 'APIUser', 'setUser' ), [ $user_data ] );
if ( $result !== false ) {
echo "Employee added successfully.<br>\n";
$insert_id = $result; //Get employees new ID on success.
} else {
echo "Employee save failed.<br>\n";
print $result; //Show error messages
}
//
//Add new punch for a specific employee
//
$punch_data = [
'user_id' => $insert_id, //ID from above newly added employee
'type_id' => 10, //Normal
'status_id' => 20, //In
'time_stamp' => strtotime( '19-Aug-2013 5:50PM' ),
'branch_id' => $new_hire_defaults['default_branch_id'], //Branch
'department_id' => $new_hire_defaults['default_department_id'], //Department
'job_id' => $new_hire_defaults['default_job_id'], //Job
'job_item_id' => $new_hire_defaults['default_job_item_id'], //Task
];
$result = postToURL( buildURL( 'APIPunch', 'setPunch' ), [ $punch_data ] );
if ( $result !== false ) {
echo "Punch added successfully.<br>\n";
$insert_id = $result; //Get employees new ID on success.
} else {
echo "Punch save failed.<br>\n";
print $result; //Show error messages
}
//
//Get TimeSheet Summary report data in raw PHP native array format. 'csv' and 'pdf' are also valid formats.
//
$config = postToURL( buildURL( 'APITimesheetSummaryReport', 'getTemplate' ), [ 'by_employee+all_time' ] );
$result = postToURL( buildURL( 'APITimesheetSummaryReport', 'getTimesheetSummaryReport' ), [ $config, 'raw' ] );
echo "Report Data: <br>\n";
var_dump( $result );
//Get data for the currently logged in user if needed:
//$current_user_data = postToURL( buildURL( 'APIAuthentication', 'getCurrentUser' ) );
//$current_user_preference = postToURL( buildURL( 'APIAuthentication', 'getCurrentUserPreference' ) );
//$current_company_data = postToURL( buildURL( 'APIAuthentication', 'getCurrentCompany' ) );
?>