Clover Cloud Web Socket Connection Web Application

The purpose of this repository is to illustrate the communication of your web application to Clover Mini to allow a merchant's customers to make payments: credit, debit, EMV contact and contactless (including Apple Pay), EBT, and more. This serves as a starting point for the JS SDK protocol integration library. Learn more about Clover integrations at clover.com/integrations.

This produces a runnable jar that will serve a web application. There are several prerequisites that must be set up for this to work:

The web application is served by Jetty, so you need a JDK installed.
The web application uses JavaScript WebSocket objects, so the browser you use must support WebSockets. See WebSocket Browser Support.
To complete a transaction end-to-end, we recommend getting a Clover Mini Dev Kit.

Create a Clover Application

Create a Clover developer account if you do not already have one.
After claiming your account, create a web app on your developer dashboard. Make sure to expand the "Web App" 'App Type' section and enter the Site URL and CORS domain of your app.

Webhook Example

If you want to use the embedded webhook example, you will need to run the example on a public facing web server. You will need to run the example before you can perform the verification of the webhook. The default address of the webhook in the example is http://<yourserver>/webhook. This can be changed by modifying the web.xml file.

There are two servlets that are used to demonstrate the webhook functionality. The webhook servlet echoes the information sent to the hook. It reads merchant authentication tokens from a file on the server running this example. The second servlet will write merchant authentication tokens to the file. There is a button on the min Cloud example that will allow you to send the current merchant authentication token to be written.

View our Webhooks Developer Docs for details on how to configure and use webhooks.

Configure the Example Application

Make sure the Cloud Pay Display app is installed for your merchant on your Clover device. For the main "Cloud Example", you will need the "App ID". On the "Your Apps" page, find and copy the "App ID".

The "Simple" examples require information that can be obtained by running the "Cloud Example".

Build and run the Example Application

You must have maven and a JDK installed.

Generate a certificate

keytool -genkey -alias jetty6 -keyalg RSA -keystore jetty-ssl.keystore -storepass jetty6 -keypass jetty6 -dname "CN=localhost"

Prepare the application to run:

mvn package

Run the app inside a jetty container:

mvn jetty:run

You will need to configure your browser to accept the certificate you generated in order to test using the SSL url (https://localhost:8443)

Note that the ports can be changed in the maven build file (pom.xml)

Make a Transaction

###High Level API This example refers to the source files in the webapp directory.

To make a payment using the High Level Cloud API ####Create the Clover object.

var clover = new Clover(configuration);

There are several ways the Clover object can be configured. See the Clover documentation for details on the CloverConfig object and how to set up your connection.

Examples of creating the Clover object:

####Define how your program will use the Clover object #####In this example, this function will be passed when we start communicating with the device. If there is an error when communication is initiated, this function will get the error as a parameter.

function makeASale(error) {
  if(error) console.log(error)
  else clover.sale({"amount" : 12345, "tipAmount" : 123 }, mySaleResult);
}

Example of function to handle device initialization and invoke an operation #####Here we define the error-first callback that we pass in to the Clover.sale function above. If an error occurs, it will be the first parameter.

function mySaleResult(error, saleResult) {
  // do something with the result
}

Example of function to handle result of an operation ####Start communicating with the device and tell the device to call your program when it is ready

clover.initDeviceConnection(makeASale);

Example of initializing the device connection