This is Cloud Computing repository of PathXplorer ----

pathXplorer API Documentation

Authentication

User Authentication

POST /register

https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com//api/auth/register

Body:

{
    "email": "youremail@example.com",
    "password": "password"
}

Example:

curl --location 'http://localhost:3000/api/auth/register' \
--data-raw '{
    "email": "youremail@example.com",
    "password": "password"
}'

Response

{
    "message": "User registered, OTP sent",
    "token": "<JWT-token>"
}

POST /register/google

https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com//api/auth/register/google

Body:

{
  "idToken": "<your-google-id-token>"
}

Example:

curl --location 'http://localhost:3000/api/auth/register/google' \
--data '{
  "idToken": "<your-google-id-token>"
}
'

Response

POST /verify-register

https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com/api/auth/verify

Body:

{
    "email": "youremail@example.com",
    "otp": "your-otp"
}

Example:

curl --location 'http://localhost:3000/api/auth/verify' \
--data-raw '{
    "email": "youremail@example.com",
    "otp": "your-otp"
}'

Response

{
    "message": "User registered, OTP sent",
    "token": "<JWT-token>"
}

POST /login

https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com/api/auth/login

Body:

{
    "email": "youremail@example.com",
    "password": "password"
}

Example:

curl --location 'http://localhost:3000/api/auth/login' \
--data-raw '{
    "email": "youremail@example.com",
    "password": "password"
}'

Response

{
    "message": "Login successful",
    "token": "JWT-token",
    "user": {
        "id": 1,
        "email": "user@example.com",
        "username": "user1",
        "provider_type": "manual"
    }
}

POST /login/google

https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com/api/auth/login/google

Body:

{
    "idToken": "<your-google-id-token>"
}

Example:

curl --location 'http://localhost:3000/api/auth/login/google' \
--data '{
    "idToken": "<token>"
}'

Response

{
    "message": "Login successful.",
    "user": {
        "id": 2,
        "email": "youremailgoogle@gmail.com",
        "username": "username google",
        "provider_type": "google"
    }
}

POST /forgot-password

URL: http://localhost:3000/api/auth/forgot-password

Body:

{
  "email": "user@example.com"
}

Example:

curl --location 'http://localhost:3000/api/auth/forgot-password' \
--data-raw '{
  "email": "user@example.com"
}'

Response:

{
  "message": "OTP sent, please check your email"
}

POST /verify-reset-password

URL: http://localhost:3000/api/auth/verify-otp

Body:

{
    "email": "youremail@example.com",
    "otp": "<your-otp>"
}

Example:

curl --location 'http://localhost:3000/api/auth/verify-otp' \
--data-raw '{
    "email": "youremail@example.com",
    "otp": "<your-otp>"
}'

Response

{
    "message": "OTP valid, proceed to reset password"
}

POST /reset-password

URL: http://localhost:3000/api/auth/reset-password

Body:

{
    "email": "youremail@example.com",
    "otp": "<your-otp>",
    "newPassword": "passwordnew"
}

Example:

curl --location 'http://localhost:3000/api/auth/reset-password' \
--data-raw '{
    "email": "youremail@example.com",
    "otp": "<your-otp>",
    "newPassword": "passwordnew"
}'

Response:

{
    "message": "Password successfully reset"
}

POST /logout

URL: https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com//api/auth/logout

Request Headers

Authorization: Bearer <token>

Example:

curl --location --request POST 'http://localhost:3000/api/auth/logout?Authorization=Bearer%20%3Ctoken%3E'

Response:

{
    "message": "Successfully logged out"
}

Profile

GET /profile

URL: https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com//api/profile/

Request Headers

Authorization: Bearer <token>

Example:

curl --location 'http://localhost:3000/api/profile/' \
--header 'Authorization: Bearer <token>'

Response:

{
    "success": true,
    "data": {
        "user_id": 1,
        "email": "user2@example.com",
        "verified_at": "2024-12-09T10:33:55.000Z",
        "testResults": [
            {
                "test_id": 4,
                "category": "R",
                "timestamp": "2024-12-03T05:00:00.000Z",
                "riasec_type": "R",
                "interest_description": "Individuals with the Realistic type are those who enjoy practical, tangible work. They like working with their hands, making, fixing or assembling things, and are often drawn to outdoor activities. This type usually enjoys using tools or machines, building something concrete, or even farming. If you are a Realistic type, you may find satisfaction in a job that allows you to see the immediate results of your efforts. You tend to like working independently or in a structured environment with little social interaction.",
                "key_skills": "Operating tools, repairing, designing, manual work, driving, caring for plants or animals.",
                "example_careers": "Pilot, Farmer, Engineer, Mechanic"
            }
        ]
    }
}

PUT /update-profile

URL: http://localhost:3000/api/profile/update

Request Headers

Authorization: Bearer <token>

Body:

{
  "email": "user@example.com",
  "username": "newusername",
  "password": "passwordupdateprofile"
}

Example:

curl --location --request PUT 'http://localhost:3000/api/profile/update' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InVzZXI0QGV4YW1wbGUuY29tIiwiaWQiOjgsImlhdCI6MTczNDAxMjk5NiwiZXhwIjoxNzM0MDk5Mzk2fQ.d8rSNrQFbP-vnHQIGXc_M6v-ZM2Oyym50oO4SHvEpCs' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "user@example.com",
  "username": "newusername",
  "password": "passwordupdateprofile"
}'

Response:

{
    "success": true,
    "message": "Profile updated successfully"
}

RIASEC

POST /save

URL: https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com/api/riasec/save-results

Body:

{
  "testId": 1,
  "userId": 1,
  "category": "R",
  "timestamp": "2024-12-03T12:00:00"
}

Example:

curl --location 'http://localhost:3000/api/riasec/save-results' \
--header 'Content-Type: application/json' \
--data '{
  "testId": 1,
  "userId": 1,
  "category": "R",
  "timestamp": "2024-12-03T12:00:00"
}
'

Response:

{
    "message": "Test result saved successfully"
}

GET /result

URL: https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com/api/riasec/test-results/:testId

Example:

curl --location 'http://localhost:3000/api/riasec/test-results/1'

Response:

{
    "test_id": 1,
    "user_id": 1,
    "category": "R",
    "timestamp": "2024-12-03T05:00:00.000Z"
}

GET /get recommendation

URL: https://backend-v3-dot-pathxplorer-442211.et.r.appspot.com/api/riasec/recommendation/:category

Response:

{
    "id": 1,
    "riasec_type": "R",
    "interest_description": "Individuals with the Realistic type are those who enjoy practical, tangible work. They like working with their hands, making, fixing or assembling things, and are often drawn to outdoor activities. This type usually enjoys using tools or machines, building something concrete, or even farming. If you are a Realistic type, you may find satisfaction in a job that allows you to see the immediate results of your efforts. You tend to like working independently or in a structured environment with little social interaction.",
    "key_skills": "Operating tools, repairing, designing, manual work, driving, caring for plants or animals.",
    "example_careers": "Pilot, Farmer, Engineer, Mechanic"
}