PerfectGym Next Device API
/
API reference
/
Access

Device API

Download OpenAPI description
deviceapi.json
deviceapi.yaml
Languages
Servers
Demo tenant
https://open-api-demo.devices.perfectgym.com/
Mock server
https://redocly.sportalliance.com/_mock/apis/perfectgym/deviceapi/deviceapi/

Access

Here are all the endpoints that are necessary for GenericCardReader to be successfully used. This endpoints should be used for device with model GENERIC_CARD_READER. The model can be found in response from getDevices which was already described in authentication process.

Operations

Checks if customer is authorized (dry-run possible)

Request

You can find more information about identification here.

Headers
Accept-Languagestring

More information about the header can be found here.

Example: de
Bodyapplication/jsonrequired
identificationanyrequired
identification.​typestringrequired
Example: "NUMBER"
Discriminator
identification.​valuestringrequired

Card number

Example: "1233588160"
identification.​formatstring

In which format the card number value was provided. All of the following examples represent the same card number

  • DECIMAL - Card number is interpreted as string of decimal numbers.
    • Example : "1173673668653440"
  • HEX_MSB - Card number is interpreted as hex string using big-endian (from most significant to least significant byte) order.
    • Example : "042b73321a3180"
  • HEX_LSB - Card number is interpreted as hex string using little-endian (from least significant to most significant byte) order.
    • Example : "80311a32732b04"
Default "DECIMAL"
Enum"DECIMAL""HEX_MSB""HEX_LSB"
shouldExecuteActionboolean

In a dry run, when the value is set to false, you will receive a validation result without customer being checked into the system. Learn more about it here.

Default true
Example: true
curl -i -X POST \
  https://open-api-demo.devices.perfectgym.com/open-api/device/cardreader/identification \
  -H 'Accept-Language: de' \
  -H 'Authorization: Bearer <YOUR_oauth2_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "identification": {
      "type": "NUMBER",
      "value": "1233588160",
      "format": "DECIMAL"
    }
  }'

Responses

OK - identification has been successfully executed. You can find more information about identification here.

Response
No content

Vending

Here are all the endpoints that are necessary for GenericVending to be successfully used. This endpoints should be used for device with model GENERIC_VENDING_READER. The model can be found in response from getDevices which was already described in authentication process.

Operations