Important: make sure all API call are made to our secure (SSL) server via https:// calls.
Do not use http:// calls, as your requests will be insecure and will be rejected.

API calls can be sent to the server via GET/POST method and must contain the following variables:

• global[api_key]
  Your unique API_KEY as specified above.
• global[api_time]
  The current GMT time at time of sending the call. Format 'YYY-MM-DD HH:MM:SS'.
• global[api_method]
  The specific method being called within the API - the full list can be found below.
  A test method, used to verify your API settings is 'verify_api'.

If you are going to be sending any data to the API it is sent in a similar format, using the global[fields] sub-array as follows:

• global[fields][first_name]
• global[fields][last_name]
• global[fields][cell]
• etc...

We have some special fields which can be used for data filtering namely:

• global[fields][from_date]
• global[fields][to_date]

An example API call written in PHP without sending any data would look like this:

$curl=curl_init();
curl_setopt_array($curl, array(
	CURLOPT_RETURNTRANSFER => 1,
	CURLOPT_URL => 'https://secure.loyal2.com',
	CURLOPT_POST => 1,
	CURLOPT_POSTFIELDS => array(
		'global[api_key]' => '-your-key-would-go-here-',
		'global[api_time]' => gmdate("Y-m-d H:i:s"),
		'global[api_method]' => 'verify_api',
		),
	));
$response=curl_exec($curl);
curl_close($curl);

An example API call written in PHP including sent data would look like this:

$curl=curl_init();
curl_setopt_array($curl, array(
	CURLOPT_RETURNTRANSFER => 1,
	CURLOPT_URL => 'https://secure.loyal2.com',
	CURLOPT_POST => 1,
	CURLOPT_POSTFIELDS => array(
		'global[api_key]' => '-your-key-would-go-here-',
		'global[api_time]' => gmdate("Y-m-d H:i:s"),
		'global[api_method]' => 'get_members',
		'global[fields][code]' => 'M000001',
		),
	));
$response=curl_exec($curl);
curl_close($curl);

All responses are in XML or JSON and adhere to the following structure:

An example of a successful call response to the verify_api method

<?xml version="1.0" encoding="UTF-8"?>
<status>API call succeeded</status>

An example of a failed call response with error message

<?xml version="1.0" encoding="UTF-8"?>
<error>001: Not sent via SSL/https connection</error>

An example of a successful call response with returned data (trimmed for ease of reading)

<?xml version="1.0" encoding="UTF-8"?>
<status>2 results found</status>
<data>
	<row>
	   <first_name>Bob</first_name>
	   <last_name>Smith</last_name>
	   <etc>etc...</etc>
	</row>
	<row>
	   <first_name>Mary</first_name>
	   <last_name>Jones</last_name>
	   <etc>etc...</etc>
	</row>
</data>