ojan208/say-it-v1

capstone project bangkit academy 2023 batch 2

• M011BSX0624 – Felicia Natania Lingga – Padjadjaran University – Machine Learning
• M002BSY0456 – Naufal Zidan Putra Irawan – Bandung Institute of Technology – Machine Learning
• M002BSX1235 – Aliza Nurazizah Azhari – Bandung Institute of Technology – Machine Learning
• C211BSY3588 – Imam Ahmad Fahrezi – Indraprasta University – Cloud Computing
• C011BSY3833 – Muhammad Fauzan Azhiima – Padjadjaran University – Cloud Computing
• A011BSY2190 – Fakhri Fajar Ramadhan – Padjadjaran University – Mobile Development

"Jangan tanya kenapa struktur folder dan kodenya nggak jelas, karena ini sesuai dengan slogan kami, yaitu I.S.K.Y atau 'Inkubasi Sukur Kaga Yaudah'."

Short Description

This is an application to grade the user's prononciation of a word. The app has lists of words, then the user can send their prononciation of those words. The app will give if their prononciation is already right or not.

User API Spec

Register User API

Endpoint : POST https://say-it-capstone-project.et.r.appspot.com/register

Request Body :

{
  "username" : "imam",
  "email": "imam@example.com",  
  "password" : "rahasia" //min 8 char
}

Response Body Success :

{
  "status": "success",
  "message": "Registration successful",
  "data": {
    "id": "12345",
    "username": "imam",
    "email": "imam@example.com"
  }
}

Response Body Error :

{
  "status": "error",
  "message": "Registration failed",
  "error_details": "Email or Username address is already in use"
}

Login User API

Endpoint : POST https://say-it-capstone-project.et.r.appspot.com/register

Request Body :

{
    "email" : "imam@example.com",
    "password" : "rahasia"
}

Response Body Success : data tersebut maksudnya token

{
  "status": "success",
  "message": "Login successful",
  "data": {
    "id": "12345",
    "username": "imam",
    "email" : "imam@example.com",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiAiMTIzNDUiLCAiaWF0IjogMTYyMzEyMzUwMH0.H6MQUMR1Jvh7zxP3kW6VXWd7OlvGp7sFcpj2ZDqkNKk"
  }
}

Response Body Error :

{
  "status": "error",
  "message": "Login failed",
  "error_details": "Invalid username or Invalid password"
}

Update User API

Endpoint : PUT /users/update

Headers :

• Authorization : token
• Content-Type : form-data

Request Body :

{
  "profile-picture":"file.img",
  "username" : "updated_username"
}

Response Body Success :

{
  "status": "success",
  "message": "User information updated successfully",
  "data": {
    "id": "12345",
    "username": "updated_username",
    "profile-picture":"file.img"
  }
}

Response Body Error :

{
  "status": "error",
  "message": "Failed to update user information",
  "error_details": ""
}

Get User API

Endpoint : GET /users Headers :

• Authorization : token

Response Body Success:

{
  "status": "success",
  "message": "User information retrieved successfully",
  "data": {
    "user_id": "12345",
    "username": "john_doe",
    "email": "john.doe@example.com"
    // additional user information
  }
}

Response Body Error :

{
  "status": "error",
  "message": "Failed to retrieve user information",
  "error_details": [
    {
      "code": "UNAUTHORIZED",
      "message": "Invalid or expired token"
    }
    // additional error details if needed
  ]
}

Get List of Words

Endpoints : GET /words?page=1

{
  "status": "success",
  "data": [
    {
        "id": "1",
        "word": "A"
    }, 
    {
        "id": "2",
        "word": "Apple"
    },
    {
        "id": "3",
        "word": "Boy"
    },
    ...
  ]
}

Response Body Error :

{
  "status": "error",
  "message": "Not Found",
}

Get Word Detail

Endpoints : GET /words/{WordID}

{
  "status": "success",
  "data": {
    "id": "1",
    "word": "A",
    "Description": "A"
  }
}

Response Body Error :

{
  "status": "error",
  "message": "Not Found",
}