Example API Calls

NOTES :

• In order to replicate requests, one may take a JWT token by calling login endpoint with his/her register info. All of these endpoints can be found in the API documentation and Swagger.
• All requests can be called without JWT token yet the caller will be treated as a guest user.
• Postman collection : final milestone collection.postman_collection.json

Get Homepage Posts

• Request Url (GET) : http://ec2-16-16-166-22.eu-north-1.compute.amazonaws.com/api/home?sortBy=CREATION_DATE&sortDirection=DESCENDING

• Info : This request returns personalized posts presented to user at homepage. If user is a guest user, most popular posts will be shown.

Params :

• sortBy
• sortDirection

If sortBy and sortDirection is not given by the developer, they will be assigned to creation date and descending as default respectively

Headers :

• Besides default headers, Authorization header need to be added to request in order to process sign in info of the user. Bearer JWT Token needs to be provided in authorization header. (If authorization token is not provided, request will be processed as if it is called by a guest user)

Example Response :

[
  {
    "id": "string",
    "title": "string",
    "postContent": "string",
    "postImage": "string",
    "poster": {
      "id": "string",
      "createdAt": "2023-12-29T18:39:08.804Z",
      "isDeleted": true,
      "username": "string",
      "password": "string",
      "email": "string",
      "role": "BASIC",
      "isVerified": true,
      "verified": true
    },
    "achievement": {
      "id": "string",
      "createdAt": "2023-12-29T18:39:08.804Z",
      "isDeleted": true,
      "title": "string",
      "description": "string",
      "icon": "string",
      "type": "GAME",
      "game": "string"
    },
    "character": {
      "id": "string",
      "createdAt": "2023-12-29T18:39:08.804Z",
      "isDeleted": true,
      "name": "string",
      "icon": "string",
      "description": "string",
      "games": [
        "string"
      ],
      "type": "string",
      "gender": "string",
      "race": "string",
      "status": "string",
      "occupation": "string",
      "birthDate": "string",
      "voiceActor": "string",
      "height": "string",
      "age": "string",
      "customFields": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    },
    "userVote": "UPVOTE",
    "forum": "string",
    "type": "GAME",
    "typeId": "string",
    "typeName": "string",
    "lastEditedAt": "2023-12-29T18:39:08.804Z",
    "tags": [
      {
        "id": "string",
        "createdAt": "2023-12-29T18:39:08.804Z",
        "isDeleted": true,
        "name": "string",
        "tagType": "GROUP",
        "color": "string"
      }
    ],
    "inappropriate": true,
    "locked": true,
    "overallVote": 0,
    "voteCount": 0,
    "createdAt": "2023-12-29T18:39:08.804Z",
    "isDeleted": true,
    "isPromoted": true
  }
]

Get Characters of a Game

• Request Url (GET) : http://ec2-16-16-166-22.eu-north-1.compute.amazonaws.com/api/character/get-game-characters?gameId=5bb15f8e-c975-4b52-91ac-5a9ba8f64586

• Info : This request returns every character associated with the provided game.

Params :

• gameId

Headers :

• Guest user and signed in user are being treated same in terms of this request, hence authorization header is not required. Image below is an example header for signed in user.

Example Response :

[
  {
    "id": "string",
    "createdAt": "2023-12-29T19:06:54.010Z",
    "isDeleted": true,
    "name": "string",
    "icon": "string",
    "description": "string",
    "games": [
      "string"
    ],
    "type": "string",
    "gender": "string",
    "race": "string",
    "status": "string",
    "occupation": "string",
    "birthDate": "string",
    "voiceActor": "string",
    "height": "string",
    "age": "string",
    "customFields": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
]

Get Profile

• Request Url (GET) : http://ec2-16-16-166-22.eu-north-1.compute.amazonaws.com/api/profile/get?userId=0ba4eca0-2ada-422c-9342-2d7a19f9ef85

• Info : Returns relevant information about the profile of the signed in user (userId is extracted from the authorization token.)

Params :

• userId

Headers :

• Besides default headers, Authorization header need to be added to request in order to process sign in info of the user. Bearer JWT Token needs to be provided in authorization header. (If authorization token is not provided, request will be resulted in an error since user will be not found hence the profile.)

Example Response :

{
  "id": "string",
  "user": {
    "id": "string",
    "createdAt": "2023-12-29T18:56:36.373Z",
    "isDeleted": true,
    "username": "string",
    "password": "string",
    "email": "string",
    "role": "BASIC",
    "isVerified": true,
    "verified": true
  },
  "achievements": [
    {
      "id": "string",
      "createdAt": "2023-12-29T18:56:36.373Z",
      "isDeleted": true,
      "title": "string",
      "description": "string",
      "icon": "string",
      "type": "GAME",
      "game": "string"
    }
  ],
  "reviewCount": 0,
  "voteCount": 0,
  "commentCount": 0,
  "postCount": 0,
  "isReviewedYet": true,
  "isVotedYet": true,
  "isCommentedYet": true,
  "isPostedYet": true,
  "isPrivate": true,
  "profilePhoto": "string",
  "games": [
    {
      "id": "string",
      "gameName": "string",
      "gameDescription": "string",
      "gameIcon": "string",
      "overallRating": 0,
      "ratingCount": 0,
      "releaseDate": "2023-12-29T18:56:36.373Z",
      "forum": "string",
      "playerTypes": [
        {
          "id": "string",
          "createdAt": "2023-12-29T18:56:36.373Z",
          "isDeleted": true,
          "name": "string",
          "tagType": "GROUP",
          "color": "string"
        }
      ],
      "genre": [
        {
          "id": "string",
          "createdAt": "2023-12-29T18:56:36.373Z",
          "isDeleted": true,
          "name": "string",
          "tagType": "GROUP",
          "color": "string"
        }
      ],
      "production": {
        "id": "string",
        "createdAt": "2023-12-29T18:56:36.373Z",
        "isDeleted": true,
        "name": "string",
        "tagType": "GROUP",
        "color": "string"
      },
      "duration": {
        "id": "string",
        "createdAt": "2023-12-29T18:56:36.373Z",
        "isDeleted": true,
        "name": "string",
        "tagType": "GROUP",
        "color": "string"
      },
      "platforms": [
        {
          "id": "string",
          "createdAt": "2023-12-29T18:56:36.373Z",
          "isDeleted": true,
          "name": "string",
          "tagType": "GROUP",
          "color": "string"
        }
      ],
      "artStyles": [
        {
          "id": "string",
          "createdAt": "2023-12-29T18:56:36.373Z",
          "isDeleted": true,
          "name": "string",
          "tagType": "GROUP",
          "color": "string"
        }
      ],
      "developer": {
        "id": "string",
        "createdAt": "2023-12-29T18:56:36.373Z",
        "isDeleted": true,
        "name": "string",
        "tagType": "GROUP",
        "color": "string"
      },
      "otherTags": [
        {
          "id": "string",
          "createdAt": "2023-12-29T18:56:36.373Z",
          "isDeleted": true,
          "name": "string",
          "tagType": "GROUP",
          "color": "string"
        }
      ],
      "minSystemReq": "string",
      "createdAt": "2023-12-29T18:56:36.373Z",
      "isDeleted": true
    }
  ],
  "reviews": [
    {
      "id": "string",
      "createdAt": "2023-12-29T18:56:36.373Z",
      "isDeleted": true,
      "reviewDescription": "string",
      "rating": 0,
      "gameId": "string",
      "reviewedBy": "string",
      "overallVote": 0,
      "voteCount": 0,
      "reportNum": 0
    }
  ],
  "groups": [
    {
      "id": "string",
      "createdAt": "2023-12-29T18:56:36.373Z",
      "isDeleted": true,
      "title": "string",
      "description": "string",
      "membershipPolicy": "PUBLIC",
      "tags": [
        "string"
      ],
      "gameId": "string",
      "forumId": "string",
      "groupIcon": "string",
      "quota": 0,
      "moderators": [
        "string"
      ],
      "members": [
        "string"
      ],
      "bannedMembers": [
        "string"
      ],
      "avatarOnly": true
    }
  ],
  "steamProfile": "string",
  "epicGamesProfile": "string",
  "xboxProfile": "string"
}