Skip to content
Personal Learning Journey

Api

POST /login

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint logt een gebruiker in door de ontvangen inloggegevens te verifiëren. Bij een succesvolle login wordt een sessie aangemaakt en opgeslagen in een cookie die naar de browser gestuurd wordt. Deze sessie-cookie zorgt ervoor dat de gebruiker ingelogd blijft. Er worden geen verdere berekeningen uitgevoerd.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een object met de volgende gegevens:

success: boolean die aangeeft of de login is gelukt. message: bevestigingstekst, bijvoorbeeld "Login successful." sessieId: unieke ID die de sessie van de gebruiker identificeert

Is het een GET, POST, anders? Welke parameters zijn er?

Dit is een POST-verzoek.

Request Body (JSON), verplichte velden:

1
2
3
4
{
  "username": "gebruikersnaam",
  "password": "wachtwoord"
}

Response (201 Created)

De Response gaat er zo ongeveer uit komen te zien. De body bevat: 

1
2
3
4
5
{
  "success": true,
  "message": "Login successful.",
  "sessieId": "07629774-f62f-4f99-afbd-7a7dd4767a09"
}

Response (400 Bad Request)

1
2
3
4
5
{
  "error": "Bad Request",
  "message": "Missing required fields in request body",
  "code": "INVALID_INPUT"
}

Response (500 Interne Serverfout)

1
2
3
4
5
{
  "error": "Internal Server Error",
  "message": "Failed to add game due to a server error",
  "code": "ADD_FAILED"
}

URL

1
POST /login

Routes

1
router.post("/login", (req, res) => loginController.handleLogin(req, res));

POST /payments

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint maakt een nieuwe betaling aan op basis van de ontvangen waarde. Het genereert een unieke order-ID, maakt een betaling aan via de payment service, slaat de orderID en transactie-ID op in de database en retourneert de transactie-ID. Er worden geen verdere berekeningen uitgevoerd.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een JSON-object met:

  • transactionId: string, de unieke ID van de gemaakte betalingstransactie.

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een POST-verzoek.

Request Body (JSON), verplichte velden:

1
2
3
{
  "value": 100.50
}

Response (201 Created)

De Response gaat er zo ongeveer uit komen te zien. De body bevat: 

1
2
3
{
  "transactionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Response (400 Bad Request)

1
2
3
4
5
{
  "error": "Bad Request",
  "message": "Missing required fields in request body",
  "code": "INVALID_INPUT"
}

Response (500 Interne Serverfout)

1
2
3
4
5
{
  "error": "Internal Server Error",
  "message": "Login failed due to a server error",
  "code": "LOGIN_FAILED"
}

URL

1
POST /payments

Routes

1
router.post("/payments", paymentController.handleCreatePayment.bind(paymentController));

GET /payments/:transactionId/status

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint haalt de status van een betaling op op basis van de meegegeven transactionId. Het controleert bij de payment service wat de huidige status is en geeft deze terug. Er worden geen verdere berekeningen uitgevoerd.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een object met de volgende gegevens:

  • status: string die de huidige status van de betaling weergeeft (bijvoorbeeld "pending", "completed", "failed").

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een GET-verzoek.

Er zijn geen verplichte velden in de request body.

De transactionId wordt meegegeven als URL-parameter. 

1
2
3
4
5
6
7
8
### Response (200 OK)

De response gaat er zo ongeveer uitzien. De body bevat:

```json
{
  "status": "completed"
}

Response (500 Interne Serverfout)

1
2
3
{
  "error": "Failed to retrieve payment status"
}

URL

1
GET /payments/:transactionId/status

Routes

1
router.get("/payments/:transactionId/status", paymentController.handleGetPaymentStatus.bind(paymentController));

GET /payments/:orderId/transaction

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint haalt de transactie-ID op die hoort bij een gegeven orderId. Het zoekt deze op in de database via de payment service en retourneert de bijbehorende transactionId. Er worden geen verdere berekeningen uitgevoerd.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een object met de volgende gegevens:

  • transactionId: string, de unieke ID van de betalingstransactie behorend bij het opgegeven orderId.

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een GET-verzoek.

Er zijn geen verplichte velden in de request body.

De orderId wordt meegegeven als URL-parameter.

Response (200 OK)

De response gaat er zo ongeveer uitzien. De body bevat:

1
2
3
{
  "transactionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Response (500 Interne Serverfout)

1
2
3
{
  "error": "Failed to retrieve transaction ID"
}

URL

1
GET /payments/transaction/:orderId

Routes

1
router.get("/payments/transaction/:orderId", paymentController.handleGetTransactionId.bind(paymentController));

DELETE /payments/cart/:user_id

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint verwijdert alle items uit de winkelwagen van de gebruiker met de opgegeven user_id. Het roept de database aan om de items te verwijderen en geeft terug of het verwijderen succesvol was. Er worden geen verdere berekeningen uitgevoerd.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een object met de volgende gegevens:

  • success: boolean die aangeeft of het verwijderen van de items is gelukt (true als succesvol, anders false).

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een DELETE-verzoek.

De user_id wordt meegegeven als URL-parameter.

Er is geen request body vereist.

Response (200 OK)

De response gaat er zo ongeveer uitzien. De body bevat:

1
2
3
{
  "success": true
}

Response (500 Interne Serverfout)

1
2
3
{
  "error": "Failed to retrieve transaction ID"
}

URL

1
DELETE /payments/cart/:user_id

Routes

1
router.delete("/payments/cart/:user_id", paymentController.handleDeleteCartItems.bind(paymentController));

PATCH /payments/updateStatus/:status/:orderId

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint werkt de status van een betaling bij op basis van de meegegeven orderId en status. Het valideert de parameters, voert de update uit in de database en geeft terug of de update succesvol was.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een object met de volgende gegevens:

  • success: boolean die aangeeft of het bijwerken van de status is gelukt (true als succesvol, anders false).

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een PATCH-verzoek.

De parameters worden meegegeven in de URL:
- status (string) — de nieuwe status die ingesteld moet worden.
- orderId (string) — het ordernummer van de betaling die bijgewerkt moet worden.

Er is geen request body vereist.

Response (200 OK)

De response gaat er zo ongeveer uitzien. De body bevat:

1
2
3
{
  "success": true
}

Response (400 Bad Request)

1
2
3
{
  "error": "Missing required parameters: status or orderId"
}

Response (500 Interne Serverfout)

1
2
3
{
  "error": "Failed to update status"
}

URL

1
PATCH /payments/updateStatus/:status/:orderId

Routes

1
router.patch("/payments/updateStatus/:status/:orderId", paymentController.handleUpdateStatus.bind(paymentController));

POST /payments/order

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint voegt een nieuwe order toe aan de database met de opgegeven orderId, userId en game_id. Het controleert of alle benodigde velden aanwezig zijn en slaat vervolgens de order op.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een JSON-object met:

  • success: boolean die aangeeft of de order succesvol is toegevoegd.
  • message: bevestigingstekst bij succes.
  • error: foutmelding bij mislukking.

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een POST-verzoek.

Request Body (JSON), verplichte velden:

1
2
3
4
5
{
  "orderId": "string",
  "userId": 123,
  "game_id": 456
}

Response (201 Created)

De Response gaat er zo ongeveer uit komen te zien. De body bevat: 

1
2
3
4
{
  "success": true,
  "message": "Order inserted successfully"
}

Response (400 Bad Request)

1
2
3
{
  "error": "Missing required order fields"
}

Response (500 Interne Serverfout)

1
2
3
4
{
  "success": false,
  "error": "Failed to insert order"
}

URL

1
POST /payments/order

Routes

1
router.post("/payments/order", paymentController.handleInsertOrder.bind(paymentController));

GET /orders/stats

Wat doet het endpoint? Iets opslaan? Iets berekenen?

Dit endpoint haalt statistieken op over het aantal orders per game. Het telt hoeveel orders er per gametitel zijn geplaatst en retourneert deze data. Er worden geen verdere berekeningen uitgevoerd.

Wat voor entiteit(en) geeft het endpoint terug?

Het endpoint retourneert een array van objecten met de volgende velden:

  • title: string, de titel van de game.
  • orderCount: number, het aantal orders dat voor deze game is geplaatst.

Is het een GET, POST, anders? Welke parameters zijn er?

Het is een GET-verzoek. Er zijn geen parameters vereist.

Response (200 OK)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
  {
    "title": "Game 1",
    "orderCount": 15
  },
  {
    "title": "Game 2",
    "orderCount": 8
  }
]

Response (500 Interne Serverfout)

1
2
3
{
  "error": "Failed to get order stats"
}

URL

1
GET /orders/stats

Routes

1
router.get("/orders/stats", (req, res) => adminOrderController.handleGetOrderStats(req, res));