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 widget URL for operator's user. Creates a new user if not found. The resulting URL already has the required token. Optional deep-link parameters can open a supported widget section on initialization.

Authorizations

X-API-KEYstringRequired

API key assigned to user's operator

Path parameters

operatorUserIdstringRequired

Operator user id, external one

Query parameters

languagestringOptional

Language for widget localization. If supplied, updates the language configured for the user. Should be one of the operator's configured languages.

Example: en

featurestring · enumOptional

Widget section to open on initialization. Unsupported or disabled feature values are ignored and the base widget URL is returned.

Example: missionsPossible values:

itemIdstring · uuidOptional

Entity identifier within the specified widget section. Applied only for missions and rewards deep links.

Example: 7aa2d8f4-0486-4f47-b056-76b7ebba3b0a

Header parameters

X-API-KEYstringRequired

API key assigned to user's operator

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

Responses

200

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

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...&feature=missions&itemId=7aa2d8f4-0486-4f47-b056-76b7ebba3b0a"
}

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

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

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

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

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

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 4 months ago

Endpoints

Send event

Get Widget URL (use it for the WebView integration)

Get widget url

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