Merge pull request #51 from Adyen/terminalApiCloud

Terminal API (Cloud) support
Adyen · Apr 30, 2018 · 8fd1bd5 · 8fd1bd5
2 parents e7ca4a5 + 3437331
commit 8fd1bd5
Show file tree

Hide file tree

Showing 11 changed files with 366 additions and 5 deletions.
diff --git a/src/Adyen/Client.php b/src/Adyen/Client.php
@@ -16,6 +16,8 @@ class Client
     const ENPOINT_LIVE_DIRECTORY_LOOKUP = "https://live.adyen.com/hpp/directory/v2.shtml";
     const API_VERSION                   = "v30";
     const API_RECURRING_VERSION         = "v25";
+    const TERMINAL_CLOUD_TEST           = "https://terminal-api-test.adyen.com";
+    const TERMINAL_CLOUD_LIVE           = "https://terminal-api-live.adyen.com";
 
     /**
      * @var Adyen_Config $config
@@ -71,6 +73,16 @@ public function setPassword($password)
         $this->_config->set('password', $password);
     }
 
+    /**
+     * Set x-api-key for Web Service Client
+     *
+     * @param $xapikey
+     */
+    public function setXApiKey($xApiKey)
+    {
+        $this->_config->set('x-api-key', $xApiKey);
+    }
+
     /**
      * Set environment to connect to test or live platform of Adyen
      *
@@ -83,10 +95,12 @@ public function setEnvironment($environment)
             $this->_config->set('environment', \Adyen\Environment::TEST);
             $this->_config->set('endpoint', self::ENDPOINT_TEST);
             $this->_config->set('endpointDirectorylookup', self::ENPOINT_TEST_DIRECTORY_LOOKUP);
+            $this->_config->set('endpointTerminalCloud', self::TERMINAL_CLOUD_TEST);
         } elseif($environment == \Adyen\Environment::LIVE) {
             $this->_config->set('environment', \Adyen\Environment::LIVE);
             $this->_config->set('endpoint', self::ENDPOINT_LIVE);
             $this->_config->set('endpointDirectorylookup', self::ENPOINT_LIVE_DIRECTORY_LOOKUP);
+            $this->_config->set('endpointTerminalCloud', self::TERMINAL_CLOUD_LIVE);
         } else {
             // environment does not exists
             $msg = "This environment does not exists use " . \Adyen\Environment::TEST . ' or ' . \Adyen\Environment::LIVE;

diff --git a/src/Adyen/Config.php b/src/Adyen/Config.php
@@ -59,6 +59,26 @@ public function getPassword()
         return isset($this->data['password']) ? $this->data['password'] : null;
     }
 
+    /**
+     * Get the Checkout API Key from the Adyen Customer Area
+     *
+     * @return mixed|null
+     */
+    public function getXApiKey()
+    {
+        return !empty($this->data['x-api-key']) ? $this->data['x-api-key'] : null;
+    }
+
+    /**
+     * Get the Point of Interest Terminal ID, used for POS Transactions with Terminal API
+     *
+     * @return mixed|null
+     */
+    public function getPOIID()
+    {
+        return !empty($this->data['POIID']) ? $this->data['POIID'] : null;
+    }
+
     public function getInputType()
     {
         if(isset($this->data['inputType']) && in_array($this->data['inputType'], $this->allowedInput)) {

diff --git a/src/Adyen/ConfigInterface.php b/src/Adyen/ConfigInterface.php
@@ -6,9 +6,11 @@
 
     public function getUsername();
     public function getPassword();
+    public function getXApiKey();
     public function get($param);
     public function getInputType();
     public function getOutputType();
     public function getMerchantAccount();
+    public function getPOIID();
 
 }
diff --git a/src/Adyen/HttpClient/CurlClient.php b/src/Adyen/HttpClient/CurlClient.php
@@ -21,6 +21,8 @@ public function requestJson(\Adyen\Service $service, $requestUrl, $params)
         $logger = $client->getLogger();
         $username = $config->getUsername();
         $password = $config->getPassword();
+        $xApiKey = $config->getXApiKey();
+
         $jsonRequest = json_encode($params);
 
         // log the request
@@ -32,14 +34,10 @@ public function requestJson(\Adyen\Service $service, $requestUrl, $params)
         //Tell cURL that we want to send a POST request.
         curl_setopt($ch, CURLOPT_POST, 1);
 
-        // set authorisation
-        curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
-        curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
-
         //Attach our encoded JSON string to the POST fields.
         curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonRequest);
 
-        // set a custom User-Agent
+        //create a custom User-Agent
         $userAgent = $config->get('applicationName') . " " . \Adyen\Client::USER_AGENT_SUFFIX . $client->getLibraryVersion();
 
         //Set the content type to application/json and use the defined userAgent
@@ -48,6 +46,21 @@ public function requestJson(\Adyen\Service $service, $requestUrl, $params)
             'User-Agent: ' . $userAgent
         );
 
+        // set authorisation credentials according to support & availability
+        if ($service->supportsXAPIKey() && !empty($xApiKey)) {
+            //Set the content type to application/json and use the defined userAgent along with the x-api-key
+            $headers[] = 'x-api-key: ' . $xApiKey;
+        } elseif ($service->supportsXAPIKey() && empty($xApiKey)) {
+            $msg = "Please insert a valid Checkout API Key in your test.ini file";
+            throw new \Adyen\AdyenException($msg);
+        } else {
+
+            //Set the basic auth credentials
+            curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
+            curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
+        }
+
+        //Set the headers
         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
 
         // return the result

diff --git a/src/Adyen/Service.php b/src/Adyen/Service.php
@@ -5,6 +5,7 @@
 class Service
 {
     private $client;
+    protected $_supportsXAPIKey = false;
 
     public function __construct(\Adyen\Client $client)
     {
@@ -25,4 +26,9 @@ public function getClient()
         return $this->client;
     }
 
+    public function supportsXAPIKey()
+    {
+        return $this->_supportsXAPIKey;
+    }
+
 }
diff --git a/src/Adyen/Service/PosPayment.php b/src/Adyen/Service/PosPayment.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Adyen\Service;
+
+class PosPayment extends \Adyen\Service
+{
+
+    protected $_runTenderSync;
+    protected $_runTenderAsync;
+    protected $_txType;
+
+    public function __construct(\Adyen\Client $client)
+    {
+        parent::__construct($client);
+
+        $this->_runTenderSync = new \Adyen\Service\ResourceModel\Payment\TerminalCloudAPI($this, false);
+        $this->_runTenderAsync = new \Adyen\Service\ResourceModel\Payment\TerminalCloudAPI($this, true);
+        $this->_supportsXAPIKey = true;
+    }
+
+    public function runTenderSync($params)
+    {
+        $result = $this->_runTenderSync->request($params);
+        return $result;
+    }
+
+    public function runTenderAsync($params)
+    {
+        $result = $this->_runTenderAsync->request($params);
+        return $result;
+    }
+
+    public function getServiceId($request)
+    {
+        if (isset($request['SaleToPOIRequest']['MessageHeader']['ServiceID'])) {
+            return $request['SaleToPOIRequest']['MessageHeader']['ServiceID'];
+        }
+        return null;
+    }
+
+}
diff --git a/src/Adyen/Service/ResourceModel/Payment/TerminalCloudAPI.php b/src/Adyen/Service/ResourceModel/Payment/TerminalCloudAPI.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Adyen\Service\ResourceModel\Payment;
+
+class TerminalCloudAPI extends \Adyen\Service\AbstractResource
+{
+
+    protected $_requiredFields = array(
+        'SaleToPOIRequest.MessageHeader.POIID',
+        'SaleToPOIRequest.MessageHeader.ServiceID',
+        //TODO fix: actually works with only first two levels
+        'SaleToPOIRequest.PaymentRequest.SaleData.SaleTransactionID.TransactionID', //reference
+        'SaleToPOIRequest.PaymentRequest.PaymentTransaction.AmountsReq.Currency',
+        'SaleToPOIRequest.PaymentRequest.PaymentTransaction.AmountsReq.RequestedAmount',
+        //PaymentData is optional, if not provided it will perform an authorisation(no refunds)
+        'SaleToPOIRequest.PaymentRequest.PaymentData.PaymentType',
+    );
+
+    protected $_endpoint;
+
+    public function __construct($service, $asynchronous)
+    {
+        if ($asynchronous) {
+            $this->_endpoint = $service->getClient()->getConfig()->get('endpointTerminalCloud') . '/async';
+        } else {
+            $this->_endpoint = $service->getClient()->getConfig()->get('endpointTerminalCloud') . '/sync';
+        }
+        parent::__construct($service, $this->_endpoint, $this->_requiredFields);
+    }
+
+}
diff --git a/src/Adyen/TransactionType.php b/src/Adyen/TransactionType.php
@@ -0,0 +1,12 @@
+<?php
+
+
+namespace Adyen;
+
+
+class TransactionType
+{
+    const NORMAL = 'Normal';
+    const REFUND = 'Refund';
+
+}