Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
pos:getting_started [2019/11/13 09:21]
branko
pos:getting_started [2020/03/31 13:10] (current)
Line 1: Line 1:
 <​html>​ <​html>​
 <div class="​block">​ <div class="​block">​
-    ​<div class="​blockText">​ +<div class="​blockText"><​h1>​Getting Started</​h1>​ 
-        ​<​h1>​Getting Started</​h1>​ +<p class="​has-line-data"​ data-line-start="​1"​ data-line-end="​2">​Our POS solution is aimed at the restaurant, counter top and unattended retail space. With a range of devices and development languages supported you’ll find a solution that fits!</​p>​ 
-        <p class="​has-line-data"​ data-line-start="​1"​ data-line-end="​2">​Our POS solution is aimed at the restaurant, +<h2 class="​code-line"​ data-line-start=3 data-line-end=4 ><a id="​POS_Devices_3"></​a>​POS Devices</​h2>​ 
-            ​counter top and unattended retail space. With a range of devices and development languages supported you’ll +<p class="​has-line-data"​ data-line-start="​4"​ data-line-end="​5">​First step in getting started is to pick your POS device from the following list of manufacturers. If you haven’t already, follow the links below to see details about your device.</​p>​ 
-            ​find a solution that fits!</​p>​ +<h3 class="​code-line"​ data-line-start=8 data-line-end=9 ><a id="​IDTech_8"></​a>​IDTech</​h3>​ 
-        <h2 class="​code-line"​ data-line-start=3 data-line-end=4><​a id="​POS_Devices_3"></​a>​POS Devices</​h2>​ +      ​<div class="​row deviceList">​ 
-        <p class="​has-line-data"​ data-line-start="​4"​ data-line-end="​5">​First step in getting started is to pick your POS +        <div class="​col-12 col-md-4">​ 
-            ​device from the following list of manufacturers. If you haven’t already, follow the links below to see +          <a href="​doku.php?​id=pos:​devices:​idtech">​<img src="/​lib/​exe/​fetch.php?​media=vp_3300.png"></​a> 
-            ​details about your device.</​p>​ +          <​h4><​a ​href="​doku.php?​id=pos:​devices:idtech">VP3300</​a></​h4>
-        <div class="​infobox info">​ +
-            <div class="​infoboxtext">​ +
-                ​Before proceeding, please make sure your device is setup successfullyCheck the <a +
-                    href="​doku.php?​id=pos:​devices">​Devices section</​a> ​to learn how to setup your device. +
-            ​</div>+
         </​div>​         </​div>​
-        <h2 class="​code-line" data-line-start=13 data-line-end=14><​a id="​How_to_Integrate_13"></​a>​How to Integrate</​h2+        <div class="​col-12 col-md-4">​ 
-        <​h3 class="​code-line"​ data-line-start=14 data-line-end=15>​<a id="Websockets_14"></​a>​Websockets</​h3>​ +          <a href="doku.php?id=pos:​devices:​idtech"><​img src="/lib/exe/fetch.php?media=vp5300.png"></​a
-        <p class="​has-line-data"​ data-line-start="​15"​ data-line-end="​16">​Our Websockets solution lets you install our +          <​h4><​a ​href="doku.php?id=pos:devices:idtech">VP5300</a></h4>
-            standalone local websockets serviceThis service provides a flexible API layer that let’s you control all +
-            aspects of the POS flow using your choice of programming language.</​p>​ +
-        <h4 class="​code-line"​ data-line-start=17 data-line-end=18><​a ​id="​Installation_17"><​/​a>​Installation</​h4>​ +
-        <​ol>​ +
-            <li class="has-line-data"​ data-line-start="​18"​ data-line-end="​19">​Download the Websockets zip file +
-                &​lt;​HERE&​gt;​.<​/li> +
-            <li class="​has-line-data"​ data-line-start="​19"​ data-line-end="​20">​Extract the folder to a location of your +
-                choosing.<​/li> +
-            <li class="​has-line-data"​ data-line-start="​20"​ data-line-end="​21">​Run <​code>​ws-setup<​/code> and follow the +
-                instructions.</​li>​ +
-            <li class="​has-line-data"​ data-line-start="​21"​ data-line-end="​23">​Run <​code>​start.bat</​code>​ (Windows) or +
-                <​code>​start.sh</​code>​ (Linux) to start the service.</​li>​ +
-        </​ol>​ +
-        <p class="​has-line-data"​ data-line-start="​23"​ data-line-end="​24">Once started, follow the below steps to get +
-            your first transaction processed!</p+
-        <​h4 ​class="​code-line"​ data-line-start=25 data-line-end=26><​a ​id="Making_your_first_transaction_25"></​a>​Making +
-                your first transaction</​h4>​ +
-    </​div>​ +
-</​div>​ +
- +
-<div class="​block">​ +
-    <div class="​blockText">​ +
-         +
- +
- +
-                   <​h4 class="​has-line-data"​ data-line-start="​26"​ data-line-end="​28">​1Authenticate.</​h4>​ +
-                   <​p>​Use the code shown to send an initialization request to the server. This will authenticate with the +
-                   ​%CompanyName gateway and retrieve settings required for operation.</​p>​ +
-                  +
- +
-    </​div>​ +
-    <div class="​blockCode">​ +
-        <​h2>​Request</​h2>​ +
-        <div class="​codeBox">​ +
-            <​ul>​ +
-                <li data-lang="​json">​JSON</​li>​ +
-            </​ul>​ +
-            <div class="​codepanel"​ data-lang="​json">​ +
-                <​pre><​code class="​javascript">​{ +
-"​type"​"​REQ_PROCESS_SALE",​ +
-"​data"​+
-      ​"amount":​ "​12.50",​ +
-      "​emvType":​ "​STANDARD",​ +
-      "​tip":​ {}, +
-      "​tax":​ {}, +
-      "​customTipAmount":​ "​0.00"​ +
-      } +
-+
-</code> +
-</pre> +
-            ​</div>+
         </​div>​         </​div>​
- +        ​<div class="​col-12 col-md-4">​ 
- +          <a href="​doku.php?​id=pos:​devices:​idtech"​><img src="/​lib/​exe/​fetch.php?​media=vp6300.png"></​a
-        <​h2>​Response</​h2>​ +          <h4><a href="doku.php?id=pos:devices:idtech">VP6300</a></h4>
-        ​<div class="​codeBox">​ +
-            <ul> +
-                ​<li data-lang="json">JSON</li+
-            </ul> +
-            ​<div class="codepanel"​ data-lang="​json">​ +
-                <​pre><​code class="​javascript">​{ +
-  "​type"​"​RES_ON_MESSAGE",​ +
-  "​data"​+
-    ​"message":​ "​INSERT_OR_SWIPE"​ +
-}, +
-  "​responseType":​ "​RESPONSE_OK"​ +
-+
-</code> +
-</pre> +
-            ​</div>+
         </​div>​         </​div>​
- +        ​<div class="​col-12 col-md-4">​ 
- +          <a href="doku.php?id=pos:​devices:​idtech"><​img src="/lib/exe/​fetch.php?​media=Augusta-overview.png"></a
-    </​div>​ +          <h4><a href="doku.php?id=pos:devices:idtech">Augusta</a></h4>
-</​div>​ +
-<div class="​block">​ +
-    <div class="​blockText">​ +
- +
- +
- +
-          <h4 class="​has-line-data" data-line-start="​29"​ data-line-end="​31">2. Initialize the device.</​h4+
-          <p> +
-             Once the service has returned ​successful authentication you can now initialize the device. Use +
-             this code and wait for the device to connect.</​p>​ +
-            +
- +
-       +
-    </​div>​ +
-    <div class="blockCode">​ +
-        <​h2>​Request</​h2>​ +
-        <div class="​codeBox"> +
-            ​<ul> +
-                <li data-lang="json">​JSON<​/li> +
-            </ul> +
-            <div class="​codepanel"​ data-lang="​json">​ +
-                <pre><code class="javascript">​{ +
-"​type":​ "​REQ_PROCESS_SALE",​ +
-"​data":​ { +
-      "​amount":​ "12.50", +
-      "​emvType"​"​STANDARD",​ +
-      "​tip"​{}, +
-      ​"tax": {}, +
-      "​customTipAmount":​ "​0.00"​ +
-      } +
-+
-</code> +
-</pre> +
-            ​</div>+
         </​div>​         </​div>​
- +        ​<div class="​col-12 col-md-4">​ 
- +          <a href="​doku.php?​id=pos:​devices:​idtech"​><img src="/​lib/​exe/​fetch.php?​media=minismart_II_detail.png"></​a
-        <​h2>​Response</​h2>​ +          <h4><a href="doku.php?id=pos:devices:idtech">Minismart II</a></h4>
-        ​<div class="​codeBox">​ +
-            <ul> +
-                ​<li data-lang="json">JSON</li+
-            </ul> +
-            ​<div class="codepanel"​ data-lang="​json">​ +
-                <​pre><​code class="​javascript">​{ +
-  "​type"​"​RES_ON_MESSAGE",​ +
-  "​data"​+
-    ​"message":​ "​INSERT_OR_SWIPE"​ +
-}, +
-  "​responseType":​ "​RESPONSE_OK"​ +
-+
-</code> +
-</pre> +
-            ​</div>+
         </​div>​         </​div>​
  
- +      ​</​div>​ 
-    ​</​div>​ +<h3 class="​code-line" data-line-start=data-line-end=7 ><a id="Ingenico_6"></​a>Ingenico</h3
-</div> +      <div class="​row deviceList">​ 
-<​div ​class="​block">​ +        <div class="​col-12 col-md-4">​ 
-    <div class="​blockText">​ +          <a href="doku.php?​id=pos:​devices:​ingenico"><​img src="/lib/​exe/​fetch.php?​media=ipp320.png"​></a
-                <h4 class="​has-line-data" data-line-start="​26" ​data-line-end="​28">3. Perform a transaction.</h4> +          <h4><a href="doku.php?id=pos:devices:ingenico">iPPC320</a></h4>
-                <p> +
-                    Once the device has connected, simply send the amount to the Websockets that you wish to process for +
-                    and the device should prompt for a card. Presenting a valid card should result in an online message +
-                    being sent to the bank and your first transaction processed! +
-                ​</p> +
-            ​ +
-      ​ +
-    </​div>​ +
-    ​<div class="​blockCode"+
-        <​h2>​Request</​h2+
-        <div class="​codeBox">​ +
-            <ul> +
-                <li data-lang="json">JSON</li> +
-            ​</ul+
-            <div class="​codepanel"​ data-lang="​json"​> +
-                ​<pre><​code class="javascript">​{ +
-"​type":​ "​REQ_PROCESS_SALE",​ +
-"​data":​ { +
-      "​amount":​ "12.50", +
-      "​emvType"​"​STANDARD",​ +
-      "​tip"​{}, +
-      ​"tax": {}, +
-      "​customTipAmount":​ "​0.00"​ +
-      } +
-+
-</code> +
-</pre> +
-            ​</div>+
         </​div>​         </​div>​
- +        ​<div class="​col-12 col-md-4">​ 
- +          <a href="​doku.php?​id=pos:​devices:​ingenico"​><img src="/​lib/​exe/​fetch.php?​media=ipp350.png"></​a
-        <​h2>​Response</​h2>​ +          <h4><a href="doku.php?id=pos:devices:ingenico">iPPC350</a></h4>
-        ​<div class="​codeBox">​ +
-            <ul> +
-                ​<li data-lang="json">JSON</li+
-            </ul> +
-            ​<div class="codepanel"​ data-lang="​json">​ +
-                <​pre><​code class="​javascript">​{ +
-  "​type"​"​RES_ON_MESSAGE",​ +
-  "​data"​+
-    ​"message":​ "​INSERT_OR_SWIPE"​ +
-}, +
-  "​responseType":​ "​RESPONSE_OK"​ +
-+
-</code> +
-</pre> +
-            ​</div>+
         </​div>​         </​div>​
- +        <div class="​col-12 col-md-4">​ 
- +          <a href="​doku.php?​id=pos:​devices:​ingenico"><​img src="/​lib/​exe/​fetch.php?​media=iuc285.png"></​a>​ 
-    </​div>​+          <​h4><​a href="​doku.php?​id=pos:​devices:​ingenico">​iUC285</​a></​h4>​ 
 +        </​div>​ 
 +      </​div>​ 
 +<​ul>​ 
 +<li class="​has-line-data"​ data-line-start="​11"​ data-line-end="​13"><​strong>​Note:</​strong>​ Our POS solution is currently only supported in North America.</​li>​ 
 +</​ul>​ 
 +<h2 class="​code-line"​ data-line-start=13 data-line-end=14 >How to Integrate</​h2>​ 
 +<h2 class="​code-line"​ data-line-start=14 data-line-end=15 ><i class="​fal fa-plug"></​i>​ Websockets</​h2>​ 
 +<p class="​has-line-data"​ data-line-start="​15"​ data-line-end="​16">​Our Websockets solution lets you install our standalone local websockets service. This service provides a flexible API layer that let’s you control all aspects of the POS flow using your choice of programming language.</​p>​ 
 +<h4 class="​code-line"​ data-line-start=17 data-line-end=18 ><a id="​Installation_17"></​a>​Installation</​h4>​ 
 +<​ol>​ 
 +<li class="​has-line-data"​ data-line-start="​18"​ data-line-end="​19">​Download the Websockets zip file &​lt;​HERE&​gt;​.</​li>​ 
 +<li class="​has-line-data"​ data-line-start="​19"​ data-line-end="​20">​Extract the folder to a location of your choosing.</​li>​ 
 +<li class="​has-line-data"​ data-line-start="​20"​ data-line-end="​21">​Run <​code>​ws-setup</​code>​ and follow the instructions.</​li>​ 
 +<li class="​has-line-data"​ data-line-start="​21"​ data-line-end="​23">​Run <​code>​start.bat</​code>​ (Windows) or <​code>​start.sh</​code>​ (Linux) to start  the service.</​li>​ 
 +</​ol>​ 
 +<p class="​has-line-data"​ data-line-start="​23"​ data-line-end="​24">​Once started, follow the below steps to get your first transaction processed!</​p>​ 
 +<h4 class="​code-line"​ data-line-start=25 data-line-end=26 ><a id="​Making_your_first_transaction_25"></​a>​Making your first transaction</​h4>​ 
 +<​ol>​ 
 +<li class="​has-line-data"​ data-line-start="​26"​ data-line-end="​29">​ 
 +<p class="​has-line-data"​ data-line-start="​26"​ data-line-end="​28">​Authenticate.<​br>​ 
 +Use the code shown to send an initialization request to the server. This will authenticate with the Worldnet gateway and retrieve settings required for operation.</​p>​ 
 +</​li>​ 
 +<li class="​has-line-data"​ data-line-start="​29"​ data-line-end="​32">​ 
 +<p class="​has-line-data"​ data-line-start="​29"​ data-line-end="​31">​Initialize the device.<​br>​ 
 +Once the service has returned a successful authentication you can now initialize the device. Use this code and wait for the device to connect.</​p>​ 
 +</​li>​ 
 +<li class="​has-line-data"​ data-line-start="​32"​ data-line-end="​35">​ 
 +<p class="​has-line-data"​ data-line-start="​32"​ data-line-end="​34">​Perform a transaction.<​br>​ 
 +Once the device has connected, simply send the amount to the Websockets that you wish to process for and the device should prompt for a card. Presenting a valid card should result in an online message being sent to the bank and your first transaction processed!</​p>​ 
 +</​li>​ 
 +</​ol>​ 
 +<h2 class="​code-line"​ data-line-start=35 data-line-end=36 >​SDK</​h2>​ 
 +<div class="​infobox warning">​ 
 +  <div class="​infoboxtext">​ 
 +    ​SDK support will be phased out for POS devices. We suggest using the Websockets instead. 
 +  ​</​div>​
 </​div>​ </​div>​
-<div class="​block">​ 
-    <div class="​blockText">​ 
-        <h4 class="​code-line"​ data-line-start=25 data-line-end=26><​a id="​Making_your_first_transaction_25"></​a>​Making 
-            your first transaction</​h4>​ 
-        ​ 
-        ​ 
-                <h4 class="​has-line-data"​ data-line-start="​40"​ data-line-end="​42">​1.Authenticate.</​h4>​ 
-                    <​p>​Use the code shown to send an initialization request to the server. This will authenticate with the 
-                    %CompanyName gateway and retrieve settings required for operation.</​p>​ 
  
-                ​<h4 class="​has-line-data"​ data-line-start="​43"​ data-line-end="​45">2.Initialize ​the device.</h4+<​h4 ​class="​code-line"​ data-line-start=36 data-line-end=37 ><a id="​Installation_36"></​a>​Installation</​h4>​ 
-                    <​p>​Once the service has returned a successful authentication via <​code>​OnSettingsRetrieved</​code>​ you +<p class="​has-line-data"​ data-line-start="​37"​ data-line-end="​38">​See Installation instructions for your corresponding device.</​p>​ 
-                    ​can now initialize the device. Use this code and wait for the device to connect.</​p>​ +<h4 class="​code-line"​ data-line-start=39 data-line-end=40 ><a id="​Making_your_first_transaction_39"></​a>​Making your first transaction</​h4>​ 
- +<​ol>​ 
-                <h4 class="​has-line-data"​ data-line-start="​46"​ data-line-end="​48">​3.Perform a transaction.<​/h4+<li class="​has-line-data"​ data-line-start="​40"​ data-line-end="43">​ 
-                    <​p>​Once the device has connected via <​code>​OnDeviceConnected</​code>,​ simply send the amount required +<p class="​has-line-data"​ data-line-start="​40" data-line-end="​42">Authenticate.<​br>​ 
-                    ​via a <​code>​processSale</​code>​ call and the device should prompt for a card. Presenting a valid card +Use the code shown to send an initialization request to the server. This will authenticate with the Worldnet gateway and retrieve settings required for operation.</p> 
-                    ​should result in an online message being sent to the bank a response from the SDK via +</​li>​ 
-                    ​<​code>​onSaleResponse</​code>​ and your first transaction processed!</​p>​ +<li class="​has-line-data"​ data-line-start="​43"​ data-line-end="​46"​
- +<p class="​has-line-data"​ data-line-start="​43"​ data-line-end="​45"​>Initialize the device.<​br>​ 
-        +Once the service has returned a successful authentication via <​code>​OnSettingsRetrieved</​code>​ you can now initialize the device. Use this code and wait for the device to connect.</​p>​ 
 +</li> 
 +<li class="​has-line-data"​ data-line-start="​46"​ data-line-end="​48">​ 
 +<p class="​has-line-data"​ data-line-start="​46"​ data-line-end="​48">​Perform a transaction.<​br
 +Once the device has connected via <​code>​OnDeviceConnected</​code>,​ simply send the amount required via a <​code>​processSale</​code>​ call and the device should prompt for a card. Presenting a valid card should result in an online message being sent to the bank a response from the SDK via <​code>​onSaleResponse</​code>​ and your first transaction processed!</​p>​ 
 +</​li>​ 
 +</ol> 
 +    
     </​div>​     </​div>​
-</​div>​ +     
 +  ​</​div>​
 </​html>​ </​html>​