Public
Documentation Settings

Core API

Public

Protected

AUTHORIZATIONBearer Token
Token

<token>

Users

AUTHORIZATIONBearer Token
This folder is using Bearer Token from folderProtected

GETUser Details

https://api.codespell.hgsoft.me/api/user/:email/details
AUTHORIZATIONBearer Token
This request is using Bearer Token from folderProtected
PATH VARIABLES
email

hugogoncalves13@ua.pt

Example Request
curl
curl --location 'https://api.codespell.hgsoft.me/api/public/user/hugogoncalves13@ua.pt/details'
200 OK
Example Response
json
{
  "email": "hugogoncalves13@ua.pt",
  "username": "Hugo1307",
  "name": "Hugo Gonçalves",
  "progress": [
    {
      "language": "JAVA",
      "completed_levels": "8",
      "total_levels": "10",
      "percentage": 0.8
    }
  ]
}
No response headers
This request doesn't return any response headers

GETUser Achievements

https://api.codespell.hgsoft.me/api/user/:email/achievements
AUTHORIZATIONBearer Token
This request is using Bearer Token from folderProtected
PATH VARIABLES
email
Example Request
curl
curl --location 'https://api.codespell.hgsoft.me/api/user/:email/achievements'
Example Response
json
{
  "achievements": [
    {
      "title": "Completed Level 1",
      "description": "Completed the first level for JAVA programming language.",
      "timestamp": 19287387120,
      "image": "/path/to/image"
    }
  ]
}
No response headers
This request doesn't return any response headers

PUTChange Password

https://api.codespell.hgsoft.me/api/user/:email/password
AUTHORIZATIONBearer Token
This request is using Bearer Token from folderProtected
PATH VARIABLES
email

hugogoncalves13@ua.pt

Bodyraw (json)
json
{
    "newPassword": "123456"
}
Example Request
curl
curl --location --request PUT 'https://api.codespell.hgsoft.me/api/user/:userEmail/change-password'
200 OK
Example Response
json
{
  "message": "Your password was successfully changed."
}
No response headers
This request doesn't return any response headers