Meng-V · April 1, 2022 15:25
diff --git a/WildApricot API Authentication.html b/WildApricot API Authentication.html
 <html>
 <head>
 <title>Sample PHP application for Wild Apricot API</title>
 </head>
 <body>
 <p>
 This application demonstrates how to use Wild Apricot API v2.

 See http://help.wildapricot.com/display/DOC/API+Version+2 for detailed description of API.<br/>

 See https://gethelp.wildapricot.com/en/articles/485-sample-api-applications#php for Smaple API applications.
 <p>
 <hr>
 <?php
  
    $waApiClient = WaApiClient::getInstance();
   
    //  Insert Api Key in the line below:
    $waApiClient->initTokenByApiKey('PLACE YOUR API KEY HERE'); // TODO: Api Key needs to be hashed.

    $account = getAccountDetails();
    $accountUrl = $account['Url'];
    
    $contactsResult = getContactsList(); 
    $contacts =  $contactsResult['Contacts'];

    foreach($contacts as $contact) {
       echo '<br />';
       echo sprintf("#%d - %s - %s - %s", $contact['Id'], $contact['DisplayName'], $contact['Email'], $contact['Status']);
    }

    function getAccountDetails()
    {
       global $waApiClient;
       $url = 'https://api.wildapricot.org/v2.2/accounts/';
       $response = $waApiClient->makeRequest($url); 
       return  $response[0]; // usually you have access to one account
    }

    function getContactsList()
    {
       global $waApiClient;
       global $accountUrl;
       $queryParams = array(
          '$async' => 'false', // execute request synchronously
          '$top' => 800, // limit result set to 10 records
          '$filter' => 'Member eq true', // filter only members
          '$select' => 'First name, Last name, Email, Status'
       ); // select only first name and last name to reduce size of json data
       $url = $accountUrl . '/Contacts/?' . http_build_query($queryParams);
       return $waApiClient->makeRequest($url);
    }

    /**
     * API helper class. You can copy whole class in your PHP application.
     */
    class WaApiClient
    {
       const AUTH_URL = 'https://oauth.wildapricot.org/auth/token';
             
       private $tokenScope = 'auto';

       private static $_instance;
       private $token;

       public function initTokenByApiKey($apiKey, $scope = null)
       {
          if ($scope) {
             $this->tokenScope = $scope;
          }

          $this->token = $this->getAuthTokenByApiKey($apiKey);
          if (!$this->token) {
             throw new Exception('Unable to get authorization token.');
          }
       }

       // this function makes authenticated request to API
       // -----------------------
       // $url is an absolute URL
       // $verb is an optional parameter.
       // Use 'GET' to retrieve data,
       //     'POST' to create new record
       //     'PUT' to update existing record
       //     'DELETE' to remove record
       // $data is an optional parameter - data to sent to server. Pass this parameter with 'POST' or 'PUT' requests.
       // ------------------------
       // returns object decoded from response json

       public function makeRequest($url, $verb = 'GET', $data = null)
       {
          if (!$this->token) {
             throw new Exception('Access token is not initialized. Call initTokenByApiKey or initTokenByContactCredentials before performing requests.');
          }

          $ch = curl_init();
          $headers = array(
             'Authorization: Bearer ' . $this->token,
             'Content-Type: application/json'
          );
          curl_setopt($ch, CURLOPT_URL, $url);
          
          if ($data) {
             $jsonData = json_encode($data);
             curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
             $headers = array_merge($headers, array('Content-Length: '.strlen($jsonData)));
          }
          curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $verb);

          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
          $jsonResult = curl_exec($ch);
          if ($jsonResult === false) {
             throw new Exception(curl_errno($ch) . ': ' . curl_error($ch));
          }

          // var_dump($jsonResult); // Uncomment line to debug response

          curl_close($ch);
          return json_decode($jsonResult, true);
       }

       private function getAuthTokenByApiKey($apiKey)
       {
          $data = sprintf("grant_type=%s&scope=%s", 'client_credentials', $this->tokenScope);
          $authorizationHeader = "Authorization: Basic " . base64_encode("APIKEY:" . $apiKey);
          return $this->getAuthToken($data, $authorizationHeader);
       }

       private function getAuthToken($data, $authorizationHeader)
       {
          $ch = curl_init();
          $headers = array(
             $authorizationHeader,
             'Content-Length: ' . strlen($data)
          );
          curl_setopt($ch, CURLOPT_URL, WaApiClient::AUTH_URL);
          curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
          curl_setopt($ch, CURLOPT_POST, true);
          curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 		  $response = curl_exec($ch);
 		  if ($response === false) {
             throw new Exception(curl_errno($ch) . ': ' . curl_error($ch));
          }
          // var_dump($response); // Uncomment line to debug response	
 		  
          $result = json_decode($response , true);
          curl_close($ch);
          return $result['access_token'];
       }

       public static function getInstance()
       {
          if (!is_object(self::$_instance)) {
             self::$_instance = new self();
          }

          return self::$_instance;
       }

       public final function __clone()
       {
          throw new Exception('It\'s impossible to clone singleton "' . __CLASS__ . '"!');
       }

       private function __construct()
       {
          if (!extension_loaded('curl')) {
             throw new Exception('cURL library is not loaded');
          }
       }

       public function __destruct()
       {
          $this->token = null;
       }
    }
 ?>
 </body>
 </html>
	<html>
	<head>
	<title>Sample PHP application for Wild Apricot API</title>
	</head>
	<body>
	<p>
	This application demonstrates how to use Wild Apricot API v2.

	See http://help.wildapricot.com/display/DOC/API+Version+2 for detailed description of API.<br/>

	See https://gethelp.wildapricot.com/en/articles/485-sample-api-applications#php for Smaple API applications.
	<p>
	<hr>
	<?php

	$waApiClient = WaApiClient::getInstance();

	// Insert Api Key in the line below:
	$waApiClient->initTokenByApiKey('PLACE YOUR API KEY HERE'); // TODO: Api Key needs to be hashed.

	$account = getAccountDetails();
	$accountUrl = $account['Url'];

	$contactsResult = getContactsList();
	$contacts = $contactsResult['Contacts'];

	foreach($contacts as $contact) {
	echo '<br />';
	echo sprintf("#%d - %s - %s - %s", $contact['Id'], $contact['DisplayName'], $contact['Email'], $contact['Status']);
	}

	function getAccountDetails()
	{
	global $waApiClient;
	$url = 'https://api.wildapricot.org/v2.2/accounts/';
	$response = $waApiClient->makeRequest($url);
	return $response[0]; // usually you have access to one account
	}

	function getContactsList()
	{
	global $waApiClient;
	global $accountUrl;
	$queryParams = array(
	'$async' => 'false', // execute request synchronously
	'$top' => 800, // limit result set to 10 records
	'$filter' => 'Member eq true', // filter only members
	'$select' => 'First name, Last name, Email, Status'
	); // select only first name and last name to reduce size of json data
	$url = $accountUrl . '/Contacts/?' . http_build_query($queryParams);
	return $waApiClient->makeRequest($url);
	}

	/**
	* API helper class. You can copy whole class in your PHP application.
	*/
	class WaApiClient
	{
	const AUTH_URL = 'https://oauth.wildapricot.org/auth/token';

	private $tokenScope = 'auto';

	private static $_instance;
	private $token;

	public function initTokenByApiKey($apiKey, $scope = null)
	{
	if ($scope) {
	$this->tokenScope = $scope;
	}

	$this->token = $this->getAuthTokenByApiKey($apiKey);
	if (!$this->token) {
	throw new Exception('Unable to get authorization token.');
	}
	}

	// this function makes authenticated request to API
	// -----------------------
	// $url is an absolute URL
	// $verb is an optional parameter.
	// Use 'GET' to retrieve data,
	// 'POST' to create new record
	// 'PUT' to update existing record
	// 'DELETE' to remove record
	// $data is an optional parameter - data to sent to server. Pass this parameter with 'POST' or 'PUT' requests.
	// ------------------------
	// returns object decoded from response json

	public function makeRequest($url, $verb = 'GET', $data = null)
	{
	if (!$this->token) {
	throw new Exception('Access token is not initialized. Call initTokenByApiKey or initTokenByContactCredentials before performing requests.');
	}

	$ch = curl_init();
	$headers = array(
	'Authorization: Bearer ' . $this->token,
	'Content-Type: application/json'
	);
	curl_setopt($ch, CURLOPT_URL, $url);

	if ($data) {
	$jsonData = json_encode($data);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
	$headers = array_merge($headers, array('Content-Length: '.strlen($jsonData)));
	}
	curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $verb);

	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	$jsonResult = curl_exec($ch);
	if ($jsonResult === false) {
	throw new Exception(curl_errno($ch) . ': ' . curl_error($ch));
	}

	// var_dump($jsonResult); // Uncomment line to debug response

	curl_close($ch);
	return json_decode($jsonResult, true);
	}

	private function getAuthTokenByApiKey($apiKey)
	{
	$data = sprintf("grant_type=%s&scope=%s", 'client_credentials', $this->tokenScope);
	$authorizationHeader = "Authorization: Basic " . base64_encode("APIKEY:" . $apiKey);
	return $this->getAuthToken($data, $authorizationHeader);
	}

	private function getAuthToken($data, $authorizationHeader)
	{
	$ch = curl_init();
	$headers = array(
	$authorizationHeader,
	'Content-Length: ' . strlen($data)
	);
	curl_setopt($ch, CURLOPT_URL, WaApiClient::AUTH_URL);
	curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	$response = curl_exec($ch);
	if ($response === false) {
	throw new Exception(curl_errno($ch) . ': ' . curl_error($ch));
	}
	// var_dump($response); // Uncomment line to debug response

	$result = json_decode($response , true);
	curl_close($ch);
	return $result['access_token'];
	}

	public static function getInstance()
	{
	if (!is_object(self::$_instance)) {
	self::$_instance = new self();
	}

	return self::$_instance;
	}

	public final function __clone()
	{
	throw new Exception('It\'s impossible to clone singleton "' . __CLASS__ . '"!');
	}

	private function __construct()
	{
	if (!extension_loaded('curl')) {
	throw new Exception('cURL library is not loaded');
	}
	}

	public function __destruct()
	{
	$this->token = null;
	}
	}
	?>
	</body>
	</html>