Cloud Api

Version 1.0.0.2020091116

The Select Pi Cloud Api allows vendors to integrate their applications with the Select Pi Plus platform. The Api is an internet facing restful endpoint.

Getting Started

To get started Leisure Design Systems (LDS) will provide the following for information per vendor.

• URL Endpoint - The url of the Api
• TenantId - Unique identifier per vendor
• Username - Username for vendor to access Api
• Passkey - Password for vendor to access Api
• Role - Vendor role which provides access to select methods in Api

Token

To make a call to Api’s methods the application must first get a token. A token can be retrieved by calling the token-get api. The received token must be passed to the Api’s method in the request Authorization header value. The token is only valid for 30 seconds.

Methods

token-get

token-get

Used to authenticate requestor and returns a token to use in other api calls. Token is valid for 30 seconds.

Request parameters

Sample request body

   {

       "TenantId": "976d7cea-2451-4304-b26d-84fd03fb72c4",

       "Username": "vendor",

       "Passkey": "somepassword",

       "Role": "vendor-u0Co7b84zy"

   }

Curl example

   curl --location --request POST 'https://us-central1-lds-prod.cloudfunctions.net/selectcloud/api/v1/token-get' \

   --header 'Content-Type: application/json' \

   --data-raw '{

   "TenantId": "976d7cea-2451-4304-b26d-84fd03fb72c4",

   "Username": "vendor",

   "Passkey": "somepassword",

   "Role": "vendor-u0Co7b84zy"

   }'

Pin Codes

The pin code methods allow vendor applications to manage pin codes customers can use at kiosks.

Methods

pin-generate

pin-generate-custom

pin-get

pin-cancel

pin-used

pin-generate

Creates a new pin code for a specified bucket size. The ball count and pricing is pulled from the information setup in the Select Administrator application.

Request parameters

Response values

Sample request body

   {  

       "BucketSize" : "small",

       "User": "Mike Cashier",

       "TransactionId" : "vendor00001",

       "ExcludeLeadingZero" : "false"

   }  

Sample response body

   {

       "Expiration": "Wed, 23 Sep 2020 18:26:46 GMT",

       "BucketSize": "small",

       "Balls": 55,

       "ChargeAmount": 5,

       "PinCode": "2784",

       "QrPinCode": "[PIN]2784",

       "TransactionId": "vendor00001",

       "Id": 1600799206101

   }

Curl example

   curl --location --request POST 'https://us-central1-lds-prod.cloudfunctions.net/selectcloud/api/v1/pin-generate' \

   --header 'Authorization: Bearer {TokenGoesHere}' \

   --header 'Content-Type: application/json' \

   --data-raw '{  

   "BucketSize" : "small",

   "User": "Mike Cashier",

   "TransactionId" : "vendor00001",

   "ExcludeLeadingZero" : "false"

   }'

pin-generate-custom

Creates a new pin code for a custom bucket size. The ball count and pricing is passed in as parameters.

Request parameters

Response values

Sample request body

   {      

       "User": "Mike Cashier",

       "Balls": 100,

       "Price" : 20.0,

       "TransactionId" : "vendor00001",

       "ExcludeLeadingZero" : "false",  

       "Expiration" : "Wed, 23 Sep 2020 1:00:00 GMT"

   }

Sample response body

   {

       "Expiration": "Wed, 23 Sep 2020 1:00:00 GMT",

       "BucketSize": "custom",

       "Balls": 55,

       "ChargeAmount": 5,

       "PinCode": "2784",

       "QrPinCode": "[PIN]2784",

       "TransactionId": "vendor00001",

       "Id": 1600799206101

   }

Curl example

   curl --location --request POST 'http://localhost:5001/lds-prod/us-central1/selectcloud/api/v1/pin-generate-custom' \

   --header 'Authorization: Bearer {TokenGoesHere}' \

   --header 'Content-Type: application/json' \

   --data-raw '{      

       "User": "Mike Cashier",

       "Balls": 100,

       "Price" : 20.0,

       "TransactionId" : "vendor00001",

       "ExcludeLeadingZero" : "false",  

       "Expiration" : "Wed, 23 Sep 2020 1:00:00 GMT"

   }'

pin-get

Retrieves information about a pin code. If the pin code has been used or cancelled no information will be returned. Only unused pin codes are returned.

Request parameters

Response values

Sample request body

   {  

   "   Pincode": 2784

   }

Sample response body

   {

       "Expiration": "Wed, 23 Sep 2020 18:26:46 GMT",

       "BucketSize": "small",

       "Balls": 55,

       "ChargeAmount": 5,

       "PinCode": "2784",

       "QrPinCode": "[PIN]2784",

       "TransactionId": "vendor00001",

       "Id": 1600799206101

   }

Curl example

   curl --location --request POST 'https://us-central1-lds-prod.cloudfunctions.net/selectcloud/api/v1/pin-get' \

   --header 'Authorization: Bearer {TokenGoesHere}' \

   --header 'Content-Type: application/json' \

   --data-raw '{  

   "Pincode": 2784

   }'

pin-cancel

Used to cancel a pin code. Will return success whether pin code was valid or not.

Request parameters

Sample request body

   {

       "Pincode": 2784,

       "User": "Mike Cashier"

   }

Curl example

   curl --location --request POST 'https://us-central1-lds-prod.cloudfunctions.net/selectcloud/api/v1/pin-cancel' \

   --header 'Authorization: Bearer {TokenGoesHere}' \

   --header 'Content-Type: application/json' \

   --data-raw '{

   "Pincode": 2784,

   "User": "Mike Cashier"

   }'

pin-use

Used to mark a pin code as used. Will return success whether pin code was valid or not.

Request parameters

Sample request body

   {

       "Pincode": 2784,

   }

Curl example

   curl --location --request POST 'https://us-central1-lds-prod.cloudfunctions.net/selectcloud/api/v1/pin-use' \

   --header 'Authorization: Bearer {TokenGoesHere}' \

   --header 'Content-Type: application/json' \

   --data-raw '{

   "Pincode": 2784

   }'

Error Codes

The Api may return error codes to help the vendor application handle error scenarios. The error codes are returned as the response status code.