Public API for data access

post

Reward from widget balance

Path parameters

userIdinteger · int64Required

Query parameters

operatorIdinteger · int64Required

Body

application/json

rewardIdstringOptional

typestring · enumOptionalPossible values:

Responses

204

No Content

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/v2/integration/user/{userId}/rewards/redeem

HTTPcURLJavaScriptPython

POST /api/v2/integration/user/{userId}/rewards/redeem?operatorId=1 HTTP/1.1
Host: integration.enable3.io
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "rewardId": "text",
  "type": "EVENT"
}

{
  "reply": "text"
}

post

Claim accumulated reward points for given mission

Path parameters

missionIdstringRequired

userIdinteger · int64Required

Query parameters

operatorIdinteger · int64Required

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/v2/integration/user/{userId}/missions/{missionId}/claim

HTTPcURLJavaScriptPython

POST /api/v2/integration/user/{userId}/missions/{missionId}/claim?operatorId=1 HTTP/1.1
Host: integration.enable3.io
Accept: */*

No content

get

Get rewards available for user

Path parameters

userIdinteger · int64Required

Query parameters

sizeinteger · int32OptionalDefault: 20

pageinteger · int32OptionalDefault: 0

langstringRequired

operatorIdinteger · int64Required

Responses

200

OK

application/json

totalinteger · int64Optional

total number of results (non paginated)

hasNextbooleanOptional

indicates if there are any results left beyond the current page

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/v2/integration/user/{userId}/rewards

HTTPcURLJavaScriptPython

GET /api/v2/integration/user/{userId}/rewards?lang=text&operatorId=1 HTTP/1.1
Host: integration.enable3.io
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "amount": 1,
      "availableForUser": true
    }
  ],
  "total": 1,
  "hasNext": true
}

get

Get all active missions by user

Path parameters

userIdinteger · int64Required

Query parameters

sizeinteger · int32OptionalDefault: 10

pageinteger · int32OptionalDefault: 0

langstringRequired

operatorIdinteger · int64Required

Responses

200

OK

application/json

totalinteger · int64Optional

total number of results (non paginated)

hasNextbooleanOptional

indicates if there are any results left beyond the current page

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/v2/integration/user/{userId}/missions

HTTPcURLJavaScriptPython

GET /api/v2/integration/user/{userId}/missions?lang=text&operatorId=1 HTTP/1.1
Host: integration.enable3.io
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "rewardAmount": 1,
      "pendingRewardsAmountToClaim": 1,
      "canClaim": true,
      "currentProgress": 1,
      "targetProgress": 1,
      "dueDate": "text",
      "progressPercent": 1
    }
  ],
  "total": 1,
  "hasNext": true
}

get

Get user's current balance

Path parameters

userIdinteger · int64Required

Query parameters

operatorIdinteger · int64Required

Responses

200

OK

application/json

amountnumberOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/v2/integration/user/{userId}/balance

HTTPcURLJavaScriptPython

GET /api/v2/integration/user/{userId}/balance?operatorId=1 HTTP/1.1
Host: integration.enable3.io
Accept: */*

{
  "amount": 1
}