Skip to main content
API docs by Redocly

Z-Score Integration API (2.0.0)

Download OpenAPI specification:Download

Complete OpenAPI specification for integration controllers under package be.zsoft.zscore.controller.integration. All endpoints and all request/response schemas are fully defined without placeholders.

Achievements

Get achievements

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}

Complete an achievement

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "SINGLE",
  • "neededCount": 0,
  • "currentCount": 0,
  • "completed": true
}

Increase achievement count

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
amount
required
integer

Responses

Request samples

Content type
application/json
{
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "SINGLE",
  • "neededCount": 0,
  • "currentCount": 0,
  • "completed": true
}

Decrease achievement count

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
amount
required
integer

Responses

Request samples

Content type
application/json
{
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "SINGLE",
  • "neededCount": 0,
  • "currentCount": 0,
  • "completed": true
}

Currencies

Get currencies

Requires role ROLE_API.

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}

Currency Offers

Get currency offers

Requires role ROLE_API.

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}

Leaderboards

Get leaderboards

Requires role ROLE_API.

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}

Get leaderboard by ID

Requires role ROLE_API.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "direction": "ASC",
  • "scoreType": "LATEST"
}

Get scores for a leaderboard

Requires role ROLE_API.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}

Add a score to a leaderboard

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
score
required
integer

Responses

Request samples

Content type
application/json
{
  • "score": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "score": 0,
  • "player": {
    }
}

Players

Create a player

Requires role ROLE_API.

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "lastSignIn": "2019-08-24T14:15:22Z",
  • "lives": 0,
  • "lastLifeUpdate": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get current player

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "lastSignIn": "2019-08-24T14:15:22Z",
  • "lives": 0,
  • "lastLifeUpdate": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Take life from the current player

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
Request Body schema: application/json
required
amount
required
integer

Responses

Request samples

Content type
application/json
{
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "lastSignIn": "2019-08-24T14:15:22Z",
  • "lives": 0,
  • "lastLifeUpdate": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Give life to the current player

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
Request Body schema: application/json
required
amount
required
integer

Responses

Request samples

Content type
application/json
{
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "lastSignIn": "2019-08-24T14:15:22Z",
  • "lives": 0,
  • "lastLifeUpdate": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Triggers

Get triggers

Requires role ROLE_API.

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}

Execute a trigger

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Responses

Wallet Operations

Create a wallet operation

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
Request Body schema: application/json
required
type
required
string (WalletOperationType)
Enum: "INCREASE" "DECREASE"
amount
required
integer
currencyId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "type": "INCREASE",
  • "amount": 0,
  • "currencyId": "2a59a322-927b-4fc7-bac8-d295c634b295"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "INCREASE",
  • "amount": 0,
  • "walletCurrencyUnit": {
    },
  • "wallet": {
    }
}

Get wallet operations for current player

Requires role ROLE_PLAYER.

Authorizations:
bearerAuth
query Parameters
page
integer >= 0
size
integer >= 1
sort
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "currentPage": 0,
  • "count": 0,
  • "lastPage": 0,
  • "total": 0,
  • "links": {
    }
}