Endpoints

Send event

post

Using this endpoint you can send events for event-based missions. Requires X-API-KEY header to resolve operator identity.

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c

Body

idstringRequired

userIdstringRequired

eventIdstringRequired

eventTagsstring[]Optional

valuenumberRequired

createdAtstringRequiredExample: 2024-02-22 10:00:00

Responses

201

No content

400

Bad Request

401

Unauthorized (missing or invalid API key)

404

User not found or unauthorized

post/api/v1/event

POST /api/v1/event HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "id": "text",
  "userId": "text",
  "eventId": "text",
  "eventTags": [
    "text"
  ],
  "value": 1,
  "createdAt": "2024-02-22 10:00:00"
}

No content

get

Get a widget URL for an operator user. Creates a new user if not found. The optional referralCode is applied only when this request creates the user and is ignored for existing users. Blank, invalid or unavailable referral codes do not block widget access. Requires X-API-KEY header to resolve operator identity.

Path parameters

operatorUserIdstringRequired

The user ID within the operator context

Example: player-123

Query parameters

languagestringOptional

Language for widget localization. Updates the user's language and must be one of the operator's configured languages.

Example: en

featurestringOptional

Widget section to open on initialization (e.g. mission or store)

Example: mission

itemIdstringOptional

Entity identifier within the specified widget section

Example: mission-123

referralCodestringOptional

Referral code of a user of the same operator. Applied only to newly created users. Ignored for existing users, blank or invalid codes, or when the referral program is disabled.

Example: ABCDEF

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c

Responses

200

Successfully returned widget URL

application/json

urlstringRequiredExample: https://widget.enable3.io?token=eyJhbGciOiJIUzI1NiJ9.example.signature

400

Bad Request (e.g. language is not configured for the operator)

401

Unauthorized (missing or invalid API key)

403

Forbidden (operator status does not allow access or widget is disabled)

get/api/v1/integration/user/{operatorUserId}/widget

GET /api/v1/integration/user/{operatorUserId}/widget HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Accept: */*

{
  "url": "https://widget.enable3.io?token=eyJhbGciOiJIUzI1NiJ9.example.signature"
}

Create user with referral code

post

Create a new operator user and apply a referral code in the same transaction. If the user already exists or the code cannot be applied, the request fails and no user is created. Requires X-API-KEY header to resolve operator identity.

Path parameters

operatorUserIdstringRequired

The user ID within the operator context

Example: player-123

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c

Body

referalCodestring · min: 1Required

Referral code to apply during user creation. Must not be blank.

Example: ABCDEFPattern: \S

Responses

201

User created and referral code applied (empty response body)

No content

400

Bad Request (missing or blank referalCode, or invalid referral relationship)

401

Unauthorized (missing or invalid API key)

403

Forbidden (operator status does not allow access)

404

Referral code not found for this operator or referral program disabled

409

Conflict (user already exists or referral code cannot be applied to the user)

post/api/v1/integration/sign-referall/{operatorUserId}

POST /api/v1/integration/sign-referall/{operatorUserId} HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "referalCode": "ABCDEF"
}

No content

Get JWT (use it for the SDK integration)

Using for mobile SDK (Android).

Get JWT

get

Get JWT for operator's user

Path parameters

operatorUserIdstringRequired

Operator user id, external one

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c

Responses

200

application/json

tokenstringOptional

Token

Example:

eyJhbGciOiJIUzUxMiJ9.eyJpZF91c2VyIjozLCJyb2xlIjoiUk9MRV9PUEVSQVRPUl9BRE1JTiIsImV4cCI6MTYxOTY5NzA2OX0.XGO-uRHzGmL7EPr18IYnz6XBhS2GJJiFBsaCO9KPt61CMpCjjz5Qy-oBsNJJQtjMmJUnOmVSJMYe0RBaVPjKQg

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

get/api/v1/integration/user/{operatorUserId}/token

GET /api/v1/integration/user/{operatorUserId}/token HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Accept: */*

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

Send revenue

Sending revenue which used for Hold to earn calculation.

Send revenue

post

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

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c

Body

requestIdstringRequired

revenuenumberRequired

datestringRequiredExample: 2024-02-22 10:00:00

Responses

200

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

post/api/v1/revenue

POST /api/v1/revenue HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "requestId": "text",
  "revenue": 1,
  "date": "2024-02-22 10:00:00"
}

No content

Assign user to segments

post

Assign one or multiple segments to user

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6d

Bodyobject[]

userIdstringRequired

Responses

200

No content

400

Bad Request

*/*

401

Unauthorized

*/*

post/api/v1/segment/users/

POST /api/v1/segment/users/ HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 60

[
  {
    "userId": "text",
    "segments": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
]

No content

Remove user from segments

delete

Remove one or multiple segments from user

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6d

Bodyobject[]

userIdstringRequired

segmentsstring[]Required

Responses

200

No content

400

Bad Request

*/*

401

Unauthorized

*/*

delete/api/v1/segment/users

DELETE /api/v1/segment/users HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 39

[
  {
    "userId": "text",
    "segments": [
      "text"
    ]
  }
]

No content

Get current token balance by operatorUserId

get

Get current token balance by operatorUserId. Requires X-API-KEY header to resolve operatorId.

Path parameters

operatorUserIdstringRequired

The user ID within the operator context

Header parameters

X-API-KEYstringRequired

API key used to resolve the operatorId (injected internally)

Responses

200

Successfully returned user balance

application/json

balancestring · decimalRequiredExample: 150.00

userExistsbooleanRequiredExample: true

401

Unauthorized (missing or invalid API key)

404

User not found or unauthorized

get/api/v1/integration/user/{operatorUserId}/balance

GET /api/v1/integration/user/{operatorUserId}/balance HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Accept: */*

{
  "balance": "150.00",
  "userExists": true
}

Add websites for operator

post

Add one or more websites to an operator's integration configuration. Requires X-API-KEY header to resolve operator identity.

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c

Body

websitesstring[]Required

Responses

201

Created

No content

400

Bad Request

401

Unauthorized (missing or invalid API key)

404

User not found or unauthorized

409

Conflict (e.g. duplicate entry)

post/api/v1/integration/websites

POST /api/v1/integration/websites HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "websites": [
    "text"
  ]
}

No content

Last updated 22 days ago

Send event

Get widget URL for operator user

Create user with referral code

Get JWT (use it for the SDK integration)

Get JWT

Send revenue

Send revenue

Assign user to segments

Remove user from segments

Get current token balance by operatorUserId

Add websites for operator