Integration API (1.0)

Download OpenAPI specification:

Amusement Connect Integration API

Organization

Organizations

Partner

Partners

Square Webhook Notification

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
type
string

The type of the Square webhook event

object (SquareEvent)

Represents a Square webhook event

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Ami Collection Notification

This endpoint is used to receive AMI collection notifications

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required

Ami Collection Notification

amiCompanyId
required
number
amiLocationId
required
number
jukeboxMacAddress
required
string
acOrganizationId
required
string <uuid>
acLocationId
required
string <uuid>
collectionId
required
number
collectionTimestamp
required
string <timestamp>
reportedTimestamp
required
string <timestamp>

Responses

Request samples

Content type
application/json
{
  • "amiCompanyId": 0,
  • "amiLocationId": 0,
  • "jukeboxMacAddress": "string",
  • "acOrganizationId": "5faf6d02-f639-4fa1-a3e1-7d2f60c44d63",
  • "acLocationId": "ffe1c621-3d48-4ee8-861e-d0d3c0d79041",
  • "collectionId": 0,
  • "collectionTimestamp": "string",
  • "reportedTimestamp": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

PartnerOrganization

Partner Organizations

PartnerLocation

Partner Locations