This file contains the documentation for teendevops' REST API version 1.

The REST API implements rate limiting to prevent spam and abuse. The default rate limit is 600 requests per hour per IP. Contact info@teendevops.net to adjust this limit.

Attempts to evade this limit will using methods including (but not limited to) the use of proxies or ip spoofing will result in a ban from the use of the REST API.

When an error occurs on the server, the variable success will be set to false. Otherwise, success will be set to true. The variable error will always contain the error message, if any.

Here is a list of the most common contents of error and their meanings:

• Request method must be POST. - This means that the request method POST must be used. GET, PUT, DELETE, or any others are not allowed.
• Parameter '...' is not set. - This means that the GET or POST parameter ... is required, and must be set.
• Parameter '...' is not valid. - This means that the GET or POST parameter ... is not valid. For example, trying to put a username where the user id belongs won't work.
• Invalid CSRF token. - This means that the GET or POST parameter csrf is either not set, or is not valid. The CSRF token can be obtained by making a GET request to auth/csrf/.
• You have hit the API rate limit. Contact info@teendevops.net to adjust this limit. - This means that you have met the limit of requests per hour. The default is 600, but if you need to adjust that limit, you can contact info@teendevops.net.

If you are confused about any of the messages stored in error, feel free to shoot an email to info@teendevops.net.

The output format of any of the endpoints can be configured by setting the parameter format. The default format is json.

Valid settings for the parameter format include:

• json - JavaScript Object Notation
• xml - Extensible Markup Language
• dump - PHP Array Dump

• http://teendevops.net/api/v1/

• GET channels/get/
• GET chat/get/
• GET users/get/
• GET users/findsimilar/
• GET auth/csrf/

• POST chat/send/
• POST auth/login/

Returns a list of channels

Parameters:

Sample Request: GET http://teendevops.net/api/v1/channels/get/?format=json

Sample Response:

{
   "success":true,
   "channels":[
      {
         "id":1,
         "title":"offtopic",
         "description":"A channel for 1337 h@xX0rz",
         "creator":"Arinerron"
      },
      {
         "id":2,
         "title":"hackers",
         "description":"Just testing",
         "creator":"Arinerron"
      },
      {
         "id":3,
         "title":"ontopic",
         "description":"A channel for 1337 h@xX0rz",
         "creator":"Arinerron"
      }
   ]
}

Returns the latest chat messages

Parameters:

Sample Request: GET http://teendevops.net/api/v1/chat/get/?channel=1&limit=2&format=json

Sample Response:

{
   "success":true,
   "channel":1,
   "limit":2,
   "chat":[
      {
         "username":"spamaccount",
         "timestamp":"2017-03-04 01:27:33",
         "channel":1,
         "message":"hey\n",
         "deleted":false,
         "message_id":1
      },
      {
         "username":"spamaccount",
         "timestamp":"2017-03-04 01:27:40",
         "channel":1,
         "message":"how r u\n",
         "deleted":false,
         "message_id":2
      }
   ]
}

Returns the details about a user

Parameters:

Sample Request: GET http://teendevops.net/api/v1/users/get/?username=Arinerron&format=json

Sample Response:

{
   "success":true,
   "user":{
      "id":1,
      "username":"Arinerron",
      "rank":2,
      "banned":false,
      "description":"I'm some random guy. Nah, I'm just too lazy to write a good tagline.",
      "languages":"Java",
      "location":"Oregon, USA",
      "icon":"\/assets\/user-icons\/97ddfbefd0638f31f6c442552f379d05.png"
   }
}

Returns a list of similar users

Parameters:

Sample Request: GET http://teendevops.net/api/v1/users/findsimilar/?language=Java&format=json

Sample Response:

{
   "success":true,
   "users":[
      {
         "id":1,
         "username":"Arinerron",
         "banned":false,
         "description":"Write something about yourself here...",
         "location":"cat location > \/dev\/null",
         "language":"Java",
         "rank":1,
         "icon":"\/assets\/user-icons\/97ddfbefd0638f31f6c442552f379d05.png"
      },
      {
         "id":3,
         "username":"mooncat39",
         "banned":false,
         "description":"I am mooncat39. hi",
         "location":"Oregon",
         "language":"Java",
         "rank":0,
         "icon":"\/assets\/user-icons\/default.png"
      }
   ]
}

Returns the session token and the csrf token

If teendevops_session cookie is set, it will return the csrf token for that sessionid. If it is not set, it will generate a sessionid and csrf token.

Parameters:

Sample Request: GET http://teendevops.net/api/v1/auth/csrf/?format=json

Sample Response:

{
   "success":true,
   "sessionid":"8cma7c63bde0f7i2nsj87753d2",
   "csrf":"6e2bfb1006713403eb88e998c189c607"
}

Sends a chat message

Requires teendevops_session cookie to be set.

Parameters:

Sample Request: POST http://teendevops.net/api/v1/chat/send/?csrf=a434c58bfac855a1a071e1f52fdde12f&message=hi+guys&channel=1

Cookie: sessionid=e414c58b9a7e6b6c2071e1f52fede75f;

Sample Response:

{
   "success":true,
   "channel":1,
   "username":Arinerron,
   "message":"hi guys"
}

Authenticates the session id sent via cookies

Requires teendevops_session cookie to be set. Will return a brand new authenticated sessionid and csrf token to use. This is to prevent session fixation.

Parameters:

Sample Request: POST http://teendevops.net/api/v1/chat/send/?username=testuser&password=testpassword&csrf=a434c58bfac855a1a071e1f52fdde12f

Cookie: sessionid=e414c58b9a7e6b6c2071e1f52fede75f;

Sample Response:

{
   "success":true,
   "sessionid":"tj0fkeh6l0vmt2u0dr7sqc3uh6",
   "csrf":"fc8e1fabf22dac6589cfa261ad643512"
}