README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

## Methods
- GET `/`
  - Response
    - 200 Ok
      - HTML `"This is a POKO server"`
- GET `/user/<id>`
  - Response
    - 200 Ok
      - JSON `{"name": "NAME", "id": "ID"}`
    - 404 Not Found
      - JSON `"Not Found"`
- GET `/user/by_name/<name>`
  - Response
    - 200 Ok
      - JSON `[{"name": "NAME", "id": "ID"}, ...]`
    - 400 Not Found
      - JSON `"Not Found"`
- GET `/user/all`
    - Same as GET `/user/by_name/`
- POST `/user/register`
  - Request
    - JSON `{"name":"NAME", "password": "PASSWORD", "id": "ID"}`
      - ID is optional
  - Response
    - 201 Created
    - 400 Bad Request
      - JSON `"UID is taken"`
    - 500 Internal Server Error
      - JSON `"No available UID left"`
      - JSON `"UID length is incorrect"`
      - JSON `"UID String is not valid"`
- POST `/user`
  - Request
    - JSON `{"id": "ID", "password": "PASSWORD", "clientid": "CLIENT_ID"}`
  - Response
    - 200 Ok
      - JSON `"SESSION_KEY"`
        - The session key is needed for any authenticated action
    - 401 Unauthorized
        - JSON `"Could not login"`
- POST `/user/logout`
  - Request
    - JSON `{"id": "ID", "session": "SESSION_KEY"}`
  - Response
    - 200 Ok
    - 401 Unauthorized
      - JSON `"Not Authenticated"`
- POST `/user/logout/all`
  - Request
    - JSON `{"id": "ID", "session": "SESSION_KEY"}`
  - Response
    - 200 Ok
      - JSON `"Logged out of everything"`
    - 401 Unauthorized
      - JSON `"Not Authenticated"`
- POST `/user/sessions`
  - Request
    - JSON `{"id": "ID", "session": "SESSION_KEY"}`
  - Response
    - 200 Ok
      - JSON `["SESSION_KEY":"CLIENT_ID"]`
    - 401 Unauthorized
      - JSON `"Not Authenticated"`