Skip to content

Authentication

Muhammad Azhim Nugroho edited this page Jun 6, 2024 · 3 revisions

This wiki page stores authenticataion-related APIs.

1. Login

  • Endpoint: /login
  • HTTP Method: POST
  • Authentication: Not required

Example Request:

{
	"email": "user@example.com",
	"password": "userpassword"
}

Example Responses:

Status Code: 200
{
	"status": "success",
	"message": "Login successful.",
	"body": {
		"id": "4312",
		"name": "John Doe",
		"email": "user@example.com",
		"token": "R4nd0mlY.g3nEr4TeD.t0KeN"
	}
}
Status Code: 400
{
	"status": "fail",
	"message": "Invalid email or password."
}
Status code: 500
{
	"status": "error",
	"message": "internal server error"
}

2. Register

  • Endpoint: /register
  • HTTP Method: POST
  • Authentication: Not required

Please use country code at the start of the phone number, e.g. 62895341517385 instead of 0895341517385.

email and phone is unique, no more than one user can use the same credentials.

Example Request:

{
	"name": "John Doe",
	"phone": "6281234567890",
	"birthday": "2000-01-30",
	"email": "user@example.com",
	"password": "userpassword",
}

Example Responses:

Status Code: 200
{
	"status": "success",
	"message": "Register successful.",
	"body": {
		"id": "4312",
		"email": "user@example.com",
		"token": "R4nd0mlY.g3nEr4TeD.t0KeN"
	}
}
Status Code: 400
{
	"status": "fail",
	"message": "Register failed."
}
Status code: 500
{
	"status": "error",
	"message": "internal server error."
}

3. Logout

  • Endpoint: /logout
  • HTTP Method: POST
  • Authentication: Required

Example Request:

{
	"user_id": "4321",
	"session_token": "r4nd0mstr1ng"
}

Example Responses:

Status Code: 200
{
	"status": "success",
	"message": "Logout successful.",
	"body": {
		"id": "4312",
		"token": ""
	}
}
Status Code: 400
{
	"status": "fail",
	"message": "Logout failed."
}
Status code: 500
{
	"status": "error",
	"message": "internal server error"
}

Clone this wiki locally