Endpoints

Send event

Send event

POSThttps://integration.enabl3.io/api/v1/event

Header parameters

Body

application/json

id*string

userId*string

eventId*string

eventTagIdsarray of string

value*number

createdAt*string

Example: "2024-02-22 10:00:00"

Response

200400401403404409

OK

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/event', {
    method: 'POST',
    headers: {
      "X-API-KEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "createdAt": "2024-02-22 10:00:00",
      "eventId": "text",
      "id": "text",
      "userId": "text",
      "value": 0
    }),
});
const data = await response.json();

Response

400401403404409

{
  "message": "text",
  "property": "text"
}

Get Widget URL (use it for the WebView integration)

The resulting URL will already have the required token. Expiration time = 1 day.

Get widget url

Get widget url for operator's user

GEThttps://integration.enabl3.io/api/v1/integration/user/{operatorUserId}/widget

Path parameters

operatorUserId*string

Operator user id, external one

Header parameters

Response

200400401403404409

OK

Body

application/json

urlstring

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/user/{operatorUserId}/widget', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

{
  "url": "text"
}

Get JWT (use it for the SDK integration)

Get JWT

Get JWT for operator's user

GEThttps://integration.enabl3.io/api/v1/integration/user/{operatorUserId}/token

Path parameters

operatorUserId*string

Operator user id, external one

Header parameters

Response

200400401403404409

OK

Body

application/json

tokenstring

Token

Example: "eyJhbGciOiJIUzUxMiJ9.eyJpZF91c2VyIjozLCJyb2xlIjoiUk9MRV9PUEVSQVRPUl9BRE1JTiIsImV4cCI6MTYxOTY5NzA2OX0.XGO-uRHzGmL7EPr18IYnz6XBhS2GJJiFBsaCO9KPt61CMpCjjz5Qy-oBsNJJQtjMmJUnOmVSJMYe0RBaVPjKQg"

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/user/{operatorUserId}/token', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

{
  "token": "eyJhbGciOiJIUzUxMiJ9.eyJpZF91c2VyIjozLCJyb2xlIjoiUk9MRV9PUEVSQVRPUl9BRE1JTiIsImV4cCI6MTYxOTY5NzA2OX0.XGO-uRHzGmL7EPr18IYnz6XBhS2GJJiFBsaCO9KPt61CMpCjjz5Qy-oBsNJJQtjMmJUnOmVSJMYe0RBaVPjKQg"
}

Send revenue

Send revenue

Send revenue received by Application. It should be in USDT.

POSThttps://integration.enabl3.io/api/v1/revenue

Header parameters

Body

application/json

requestId*string

revenue*number

date*string

Example: "2024-02-22 10:00:00"

Response

200400401403404409

OK

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/revenue', {
    method: 'POST',
    headers: {
      "X-API-KEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestId": "text",
      "revenue": 0,
      "date": "2024-02-22 10:00:00"
    }),
});
const data = await response.json();

Response

400401403404409

{
  "message": "text",
  "property": "text"
}

Additional not mandatory endpoints

Not mandatory endpoints for integration that you can use for your own business logic:

Create user account

POSThttps://integration.enabl3.io/api/v1/integration/user

Header parameters

Body

application/json

userId*string

Response

201400401403404409

Created

Body

application/json

userIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/user', {
    method: 'POST',
    headers: {
      "X-API-KEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "text"
    }),
});
const data = await response.json();

Response

201400401403404409

{
  "userId": "text"
}

Override user's withdrawal optionsr

Send the list of withdrawal options that need to be shown for the specific user. Overrides default list.

POSThttps://integration.enabl3.io/api/v1/user-withdraw-options

Header parameters

Body

application/json

bodyUserPersonalizedWithdrawOptionsDto (object)

operatorIdstring (uuid)

Response

200400401403404405500

OK

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/user-withdraw-options', {
    method: 'POST',
    headers: {
      "X-API-KEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404405500

{
  "message": "text",
  "property": "text"
}

Get widget theme

GEThttps://integration.enabl3.io/api/v1/integration/widget-theme

Header parameters

Response

200400401403404409

OK

Body

application/json

valuestring

colorsarray of ThemeColor (object)

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/widget-theme', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

{
  "value": "text",
  "colors": [
    {
      "type": "text",
      "color": "text"
    }
  ]
}

Get all withdraw options

Get all withdraw options in status ACTIVE for operator

GEThttps://integration.enabl3.io/api/v1/integration/withdraw-options

Header parameters

Response

200400401403404409

OK

Body

application/json

createdAtstring

Example: "2024-02-22 10:00:00"

idstring (uuid)

amountnumber

namestring

descriptionstring

dueDatestring (date)

statusenum

ACTIVEDEACTIVATED

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/withdraw-options', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

[
  {
    "createdAt": "2024-02-22 10:00:00",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 0,
    "name": "text",
    "description": "text",
    "dueDate": "2024-11-21",
    "status": "ACTIVE"
  }
]

Get withdraw history

Get withdraw history for operator user

GEThttps://integration.enabl3.io/api/v1/integration/user/{operatorUserId}/withdraw-history

Path parameters

operatorUserId*string

Query parameters

Header parameters

Response

200400401403404409

OK

Body

application/json

resultsarray of WithdrawHistoryDto (object)

results for the requested page

totalinteger (int64)

total number of results (non paginated)

hasNextboolean

indicates if there are any results left beyond the current page

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/user/{operatorUserId}/withdraw-history', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

{
  "results": [
    {
      "amount": 0,
      "withdrawOptionId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "createdAt": "2024-02-22 10:00:00"
    }
  ],
  "hasNext": false
}

Get all missions

Get all missions in status ACTIVE for operator

GEThttps://integration.enabl3.io/api/v1/integration/missions

Header parameters

Response

200400401403404409

OK

Body

application/json

idstring (uuid)

missionNamestring

creationDatestring

Example: "2024-02-22 10:00:00"

totalRewardnumber

missionStatusenum

ACTIVEDRAFTDELETEDDEACTIVATEDEXPIRED

missionTypeenum

COUNTAMOUNT

targetValuenumber

rewardAmountnumber

dueDatestring

Example: "2024-02-22 10:00"

eventIdstring (uuid)

tagsarray of EventTagDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/missions', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "missionName": "text",
    "creationDate": "2024-02-22 10:00:00",
    "totalReward": 0,
    "missionStatus": "ACTIVE",
    "missionType": "COUNT",
    "targetValue": 0,
    "rewardAmount": 0,
    "dueDate": "2024-02-22 10:00",
    "eventId": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "hasAssociations": false
      }
    ]
  }
]

Get all events

Get all events in status ACTIVE for operator

GEThttps://integration.enabl3.io/api/v1/integration/events

Header parameters

Response

200400401403404409

OK

Body

application/json

idstring (uuid)

namestring

descriptionstring

statusenum

ACTIVEDISABLEDDELETED

tagsarray of EventTagDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://integration.enabl3.io/api/v1/integration/events', {
    method: 'GET',
    headers: {
      "X-API-KEY": "text"
    },
});
const data = await response.json();

Response

200400401403404409

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "hasAssociations": false
      }
    ]
  }
]