API Documentation (1.0)

Download OpenAPI specification:Download

Authentication and authorization @epicmaxim.net

Activation

Activate user

Activates user

Request Body schema: application/json

Entity

activateToken	string
email	string

Responses

Request samples

Payload

Content type

application/json

{"activateToken": "string",
"email": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Resend activation email

Resends activation email

Request Body schema: application/json

Entity

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Account

Check authentication

Checks authentication status using session token

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Responses

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Get profile

Output basic account information

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Responses

Response samples

200

Content type

application/json

{"profile": {"badges": ["string"
],
"bio": "string",
"email": "string",
"firstname": "string",
"followers": 0,
"following": 0,
"id": 0,
"isFollowed": true,
"photo": "string",
"registrationDate": "string",
"username": "string"
},
"status": "string"
}

Close session

Wipes selected session

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

id

integer

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Get sessions

Output account sessions

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Responses

Response samples

200

Content type

application/json

{"currentSession": {"browser": "string",
"browserVersion": "string",
"city": "string",
"country": "string",
"createdAt": "string",
"deviceType": "string",
"id": 0,
"ip": "string",
"os": "string",
"osVersion": "string",
"updatedAt": "string",
"userAgent": "string"
},
"sessions": [{"browser": "string",
"browserVersion": "string",
"city": "string",
"country": "string",
"createdAt": "string",
"deviceType": "string",
"id": 0,
"ip": "string",
"os": "string",
"osVersion": "string",
"updatedAt": "string",
"userAgent": "string"
}
],
"status": "string"
}

Update profile

Updates basic profile information

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

bio	string
firstname	string

Responses

Request samples

Payload

Content type

application/json

{"bio": "string",
"firstname": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Update email

Updates user email

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Update password

Updatess account password

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

currentPassword	string
newPassword	string

Responses

Request samples

Payload

Content type

application/json

{"currentPassword": "string",
"newPassword": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Update photo url

Updates user photo url

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

photo

string

Responses

Request samples

Payload

Content type

application/json

{"photo": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Update username

Updates user name

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

username

string

Responses

Request samples

Payload

Content type

application/json

{"username": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

List

Get a user

Gets basic profile information by username

query Parameters

username

string

Example: username="sometext"

string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Get a user

Gets basic profile information by email

query Parameters

email

string

Example: email="sometext"

string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

View users

Output basic user information using certain criteria

query Parameters

search	string Example: search="sometext" string
limit	integer Example: limit=30 int
offset	integer Example: offset=10 int

Responses

Response samples

200

Content type

application/json

{"data": [{"badges": ["string"
],
"bio": "string",
"email": "string",
"firstname": "string",
"followers": 0,
"following": 0,
"id": 0,
"isFollowed": true,
"photo": "string",
"registrationDate": "string",
"username": "string"
}
],
"status": "string",
"total": 0
}

Health

Health check

Output status, version, response code and time

Responses

Authentication

Log in

Authenticates user

Request Body schema: application/json

Entity

password	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"username": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Log out

Logs user out

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Responses

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Register

Registration

Request Body schema: application/json

Entity

email	string
password	string
username	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string",
"username": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Reset password

Resets user password

Request Body schema: application/json

Entity

email	string
password	string
resetToken	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string",
"resetToken": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Reset check

Checks if user can reset password

query Parameters

email	string Example: email="[email protected]" string
resetToken	string Example: resetToken="8dd81ef52f1f2b1cc6af0d7dd9930499" string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Restore

Sends email with reset URL

Request Body schema: application/json

Entity

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Stats

Output common stats