Enable3
WebsiteCommunity
  • 🚀getting started
    • What is Enable3?
    • Register and Log In
    • Admin Panel (Enable3 Account)
    • Basic Setup
  • 🪄HOW IT WORKS
    • Missions
    • Quests
    • Rewards & Redeem
    • Hold to Earn
      • Hold to Earn: No Code
    • Tap to Earn
    • Referral program
    • Web3 loyalty
    • System Events
  • ⚙️TECH
    • Integration
      • SDK
      • WebView
    • Endpoints
    • Callback
  • 🔵WEB3
    • Mechanics
    • Tokenomics
Powered by GitBook
On this page
  1. TECH

Endpoints

Last updated 19 days ago

Send event

Using this endpoint you can send events for event-based missions.

Get Widget URL (use it for the WebView integration)

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

Get JWT (use it for the SDK integration)

Using for mobile SDK (Android).

Send revenue

Sending revenue which used for Hold to earn calculation.

⚙️

Get widget url

get

Get widget url 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
OK
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
get
GET /api/v1/integration/user/{operatorUserId}/widget HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Accept: */*
{
  "url": "text"
}

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
OK
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
get
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 event

post
Header parameters
X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6d
Body
idstringRequired
userIdstringRequired
eventIdstringRequired
eventTagIdsstring[]Optional
valuenumberRequired
createdAtstringRequiredExample: 2024-02-22 10:00:00
Responses
200
OK
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
post
POST /api/v1/event HTTP/1.1
Host: integration.enable3.io
X-API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 113

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

No content

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
OK
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
post
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
Body
userIdstringRequired
Responses
200
OK
400
Bad Request
*/*
401
Unauthorized
*/*
post
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
Body
userIdstringRequired
segmentsstring[]Required
Responses
200
OK
400
Bad Request
*/*
401
Unauthorized
*/*
delete
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
Path parameters
operatorUserIdstringRequired
Header parameters
X-API-KEYanyRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c
Responses
200
OK
application/json
400
Bad Request
*/*
404
Not Found
*/*
get
GET /api/v1/integration/user/{operatorUserId}/balance HTTP/1.1
Host: integration.enable3.io
X-API-KEY: null
Accept: */*
{
  "balance": 1,
  "userExists": true
}
  • POSTSend event
  • GETGet widget url
  • GETGet JWT
  • POSTSend revenue
  • POSTAssign user to segments
  • DELETERemove user from segments
  • GETGet current token balance by operatorUserId