Get data

De volgende functies kunnen aangeroepen worden voor het ontvangen van de bijhorende data uit jouw Spari Zakelijk beheerpaneel.

Kijk of customer bestaat

Om te weten of een customer bestaat, of reeds al gekoppeld is aan jouw website, gebruiken we onderstaande variabel. Deze variabel dient overigens gebaseerd te zijn op de eerder door Spari verstreken customer hash id.

/*/ 
 * Check if the customer session is valid
 * Parameter $session can be used to validate if session exists
 * Without parameter the function will use the $spari->sessionCustomer variable
 * Return (string): 
 * - VALID (when user session exists)
 * - INVALID (when user session was not found)
/*/ 
$spari->checkCustomer($session = '');

Weergeef de huidige kaarten

Om de kaarten die jouw klanten bij jou hebben gespaard te weergeven, kan je de volgende code gebruiken. Deze laad overigens alleen data uit als jij beschikt over de eerder door Spari verstreken customer hash id.

/*/ 
 * Receive all client's cards and stamps
 * Will use the $spari->sessionCustomer to identify customer
 * Return (array) params: 
 * -  title (the card deal)
 * -  amount (current amount of stamps)
 * -  required (total stamps required)
 * -  completed (status of completed)
 * -  image (url to uploaded image)
/*/ 
$results = $spari->myCards();

Weergeef de te ontvangen beloning

Wanneer de klant diverse items heeft in een winkelwagen, is het fijn voor de consument om te kunnen zien hoeveel stempels deze zal ontvangen. Aan de hand van de id's welke in de winkelwagen zitten en gebruikt worden voor de producten, zal de API ervoor zorgen dat er een beloning berekend zal worden.

Het uitlezen van de beloningen zal op de volgende wijze gedaan moeten worden.

// This is the format the API will have to receive to be able to read the rewards 
// The array will contain demo data, you have to adjust these to your own software
$rewards = array(
  // this is the total value of the order, which is used for
  'value' => '100.00', 

  // the items element will be containing all the product and category id's
  'items' => array( 
     // this array will contain all the product ids and attached data
     'products' => array(
	'1' => array( // this array will contain all the necessary product data
	   'category_id' => '8', // tell the API what the category_id of the product is
	   'amount' => '2', // provide the amount of products in the cart that have this product_id
	   'name' => 'Test product 1' // tell the API what the name of this product is
	)
     )
  )
);

// Request to read the possible rewards
// Output the API gives will be based on howmuch the $order_value is and the previously mentioned $rewards format
$results = $spari->readRewards($order_value, $rewards);