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
post
/api/v1/event

No content

Get Widget URL (use it for the WebView integration)arrow-up-right

Get widget url

get

Get widget URL for operator's user. The resulting URL will already have the required token. Expiration time = 1 day.

Authorizations
X-API-KEYstringRequired

API key assigned to user's operator

Path parameters
operatorUserIdstringRequired

Operator user id, external one

Query parameters
referralCodestringOptional

Referral code provided by the operator on behalf of the user. If supplied, it will be applied as if the user entered it manually (e.g. during registration on the operator's side).

Example: REF123ABC
Header parameters
X-API-KEYstringRequired

API key assigned to user's operator

Example: d08c7c3e-ab43-49c2-8a36-ffb6d1ef8c6c
Responses
chevron-right
200

OK

application/json
urlstringRequired

Widget URL with embedded authentication token (valid for 1 day)

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

Get JWT (use it for the SDKarrow-up-right 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
chevron-right
200

OK

application/json
tokenstringOptional

Token

Example: eyJhbGciOiJIUzUxMiJ9.eyJpZF91c2VyIjozLCJyb2xlIjoiUk9MRV9PUEVSQVRPUl9BRE1JTiIsImV4cCI6MTYxOTY5NzA2OX0.XGO-uRHzGmL7EPr18IYnz6XBhS2GJJiFBsaCO9KPt61CMpCjjz5Qy-oBsNJJQtjMmJUnOmVSJMYe0RBaVPjKQg
get
/api/v1/integration/user/{operatorUserId}/token

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
chevron-right
200

OK

No content

post
/api/v1/revenue

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
chevron-right
200

OK

No content

post
/api/v1/segment/users/

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
chevron-right
200

OK

No content

delete
/api/v1/segment/users

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
chevron-right
200

Successfully returned user balance

application/json
balancestring · decimalRequiredExample: 150.00
userExistsbooleanRequiredExample: true
get
/api/v1/integration/user/{operatorUserId}/balance

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
post
/api/v1/integration/websites

No content

Last updated