Skip to main content

API Contract for Hiring! (1.0.0)

Download OpenAPI specification:Download

Serving document as you like!

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Auth

Everything about Authentications

Login to system

Request Body schema: application/json

Optional description in Markdown

username
string
password
string <password>
login_form
string
Enum: "website" "mobile"
fcm_token
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "pa$$word",
  • "login_form": "website",
  • "fcm_token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "login success",
  • "data": {
    }
}

refresh user token

Authorizations:
Request Body schema: application/json

Optional description in Markdown

user_id
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0
}

Response samples

Content type
application/json
{
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiYzZjYjVhMTQ1NDZlMThiYjM1MDc1NDIwYTVhMjZhZDdhOTEzMGQyNmExZjYwMjYxZjJlMmIzNDcxZmVkMmFlZWQzMTE3MWNiN2RjNDg2MDkiLCJpYXQiOjE2MzgzMjY0NzAsIm5iZiI6MTYzODMyNjQ3MCwiZXhwIjoxNjY5ODYyNDcwLCJzdWIiOiIxNDQwIiwic2NvcGVzIjpbXX0.Jj4n9-L0brCQiFqjEGtPyM2tbDX41S-QiVsSclomYwZvkixP8K2ojHxCahhr1Li3V2pUST67dUDaSy3unI044n69Dqo-1ab06g3VweMAkfgVgaDL8z6mb1uOY1NWB-3Vauv19EnSmD5v4yYQkj3iXo6dOi10eZgF2pAocguTqgwKRyq7wKAMbbvteKQj4pW1hA2neaxUP34Cn26rhfQ-Mdo48autrX2m6DUIq6eCZqgXvw5Hsu40pyMU8h54Dmiim-fiLv7u7ixUdrCE4wGYk1oG_lXo13Sgd6e5RpdbjTi647KUx7305Gsf6quaIqUy2wSXgvtM_viFnBcb4x3f3nxQDfXXQ4ATfoRd5Ld8Of4CitKZqMsK4UeP4mnXDxGLqPwTlOHOSOaxffz3tOwcm9oitdH6rF1KtAqCjXBTDsuJmjPE57pBOeOZMIiMxoyVwS_nugyUZKy1h3gbmcWMOIFY8QtH7OEc7F1suDRIxi15tM9LxtzWUuChVYzhzQDEBbUhU1k1C7sNdCHjsIHbYQNv9Pdpv23GmZRqL8aBVtESPHaAqLgsnHnvOLRxVPRtYqpRNT6OzsPN6-EMJLfShtPeXIacXA6LcoxOtWPyqFoPBqQ7dTzIomjcMzPghb1HFQkW6fl9CkmxQeUCtskFxlxcCRNri35o3PoYAoS0bk"
}

Send email reset password

Request Body schema: application/json

Optional description in Markdown

email
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "status": true,
  • "code": 200,
  • "message": "Reset Password Link has been sent to your email, please check your email!"
}

change password

Authorizations:
Request Body schema: application/json

Optional description in Markdown

id
integer
password
string <password>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "Successfully update password!"
}

Logout from system

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "code": 200,
  • "message": "Logout Successfully"
}

change password for authenticated user

Authorizations:
Request Body schema: application/json

Optional description in Markdown

id
integer
password_old
string <password>
password
string <password>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "password_old": "pa$$word",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "Successfully update password!"
}

re-send email

Authorizations:
path Parameters
user_id
required
integer

Numeric ID of the user to get

Responses

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "email verification has been resent",
  • "data": {
    }
}

User

Users endpoint