Resources - Pjiwm/circle-project GitHub Wiki

API Endpoints:

Room

  • GET /room Gets all rooms

   [
        {
            "_Id":1,
            "Streamer":["gjadgajsahwe8889d"],
            "Title":"Crazy Stream!",
            "Viewers":100,
            "IsLive":true
        },
        {
            "_Id":2,
            "Streamer":["gjadgajsahwe8889d"],
            "Title":"Crazy Stream!",
            "Viewers":100,
            "IsLive":true
        },
        {
            "_Id":3,
            "Streamer":["gjadgajsahwe8889d"],
            "Title":"Crazy Stream!",
            "Viewers":100,
            "IsLive":true
        },
        {
            "_Id":4,
            "Streamer":["gjadgajsahwe8889d]",
            "Title":"Crazy Stream!",
            "Viewers":100,
            "IsLive":true
        }
     ]
  • GET /room/:id Gets the room matching specified ID
      {
          "_Id":4,
          "Streamer":["gjadgajsahwe8889d"],
          "Title":"Crazy Stream!",
          "Viewers":100,
          "IsLive":true
      }
  • PUT /room/:id Updates the room matching specified ID
      {
          "_Id":4,
          "Streamer":["gjadgajsahwe8889d"],
          "Title":"Crazy Stream!",
          "Viewers":100,
          "IsLive":true
      }

Person

  • GET /person Get all people
[
     {
         "_id":1,
         "Name":"Harry",
         "PublicKey":"OAIlfa;mpgh[fufahlajlnsflANolfhgoawo23iholadfbt24pihtglslba",
         "Satochi":0.00009,
         "Followed":[2,4]
     },
     {
         "_id":2,
         "Name":"Peter",
         "PublicKey":"OAIlfa;mpgh[fufahlajlnsflANolfhgoawo23iholadfbt24pihtglslba",
         "Satochi":0.00009,
         "Followed":[2,4]
     },
     {
         "_id":1,
         "Name":"Harry",
         "PublicKey":"OAIlfa;mpgh[fufahlajlnsflANolfhgoawo23iholadfbt24pihtglslba",
         "Satochi":0.00009,
         "Followed":[2,4]
     }
]
  • GET /person/:id Gets the person matching the specified ID
{
    "_id":2,
    "Name":"Herbert",
    "PublicKey":"AAO:fa/ajfAigbol24labs;1LAHG",
    "Satochi":500.21884875,
    "Followed":[1]
}
  • POST /auth/login Gets the person depending on the attached signature
{
    "_id":2,
    "Name":"Herbert",
    "PublicKey":"AAO:fa/ajfAigbol24labs;1LAHG",
    "Satochi":500.21884875,
    "Followed":[1]
}
  • PUT /person/:id Updates the person matching the specified ID
{
    "_id":2,
    "Name":"Herbert",
    "PublicKey":"AAO:fa/ajfAigbol24labs;1LAHG",
    "Satochi":999.9999999999999,
    "Followed":[1,2,3,4]
}

Chat

  • POST /chats Adds a new chatmessage to the DB
{
        "personId":3,
        "room":2,
        "message":"I am a new message!",
        "dateTime":"2022-06-15 00:00:10",
        "signature":"AGHPAHGOAhohtohsough2oh3orfo;uh2o;4guf"
}

Development

  • POST /room Adds a new room
  • POST /person Adds a new person