Tws

Telll web services

View project on GitHub

Telll

Telll is an advertising system, a social network and a video-sharing website. Telll empowers a tree layered (commercial/social/entertainmen) environment aimed to deal with:

  1. Non Intrusive Advertising (NIA)
  2. Qualified Click.

The system's architecture and infra structure was developed to be fast, robust and simple. This is a tailored solution specialized to perform the service offered by the system. So, having been developed thinking on the economy and performance, by its simplicity, telll is the safest and most efficient system in its class and can keep millions of simultaneous connections with users without losing the speed of response.

Relying on the most classic and used Internet protocol, the HTTP and, when needed more interactivity, on the new Websocket, a protocol available on almost modern mobile, providing full-duplex communication channels over a single TCP connection.

Telll Web Services

End Points

Auth operations

POST /login

Login with username and password

  • Request (application/json)

    • Headers

      X-API-Key: 123

    • Body

      {
    "user_name": "smokemachine",
    "password": "12345",
    "model": "iPad"
}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Vary: Origin
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"auth_key":"ab151c3ed8135147509b32c0a9f3d6381ef0a8c2","device":"1461"}

POST /login/461

Login with device Id

  • Request (application/json)

    • Headers

      X-API-Key: 123

    • Body

      {
    "user_name": "smokemachine",
    "password": "12345"
}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Vary: Origin
Access-Control-Max-Age: 3600
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"device":"1461","auth_key":"65b8e748b316f340cf87425426cc431d82960123"}

DELETE /login

logout

  • Request

    • Headers

      X-Auth-Key: 026a26b104c736e18ba0bbaa2130259643e8d1cf
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin

    • Body

      {"logout":true}

Movie operations

POST /app/movie

movie create

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {
    "title": "",
    "description": ""
}

  • Response 201 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Vary: Origin
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"id":"112","created":true}

GET /app/movie/112

get movie by id

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Vary: Origin, Origin
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"id":"112","category":"NYI","author":"NYI","cript":"NYI","player":{"_":"NYI"},"description":"","media":{"_":"NYI"},"title":""}

GET /app/movie/0/photolinks

get photolinks from movie with movieId

  • Request

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Vary: Origin, Origin
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Access-Control-Allow-Origin: *

    • Body

      {"photolinks":[{"thumb":"http:\/\/www.clker.com\/cliparts\/6\/f\/f\/3\/1197086068917675051egore_Thumb_Up_.svg","photolink":{"title":null,"description":null,"link":[],"sponsor":"NYI","id":"1","role":"NYI","category":"NYI"}},{"thumb":"http:\/\/www.clker.com\/cliparts\/6\/f\/f\/3\/1197086068917675051egore_Thumb_Up_.svg","photolink":{"title":null,"description":null,"sponsor":"NYI","link":[],"role":"NYI","id":"1","category":"NYI"}},{"photolink":{"category":"NYI","sponsor":"NYI","link":[],"id":"1010","role":"NYI","description":"jLSS682HmX4vYmV83dfhyKAgsntDyo0kKWnStGp2bkuo54lWrC2rtLrhwbuN3lHNAYRHY7w1fitCXPnd3G6ONkoGwpuYtwThxA6oReVbfK1JsvHFycPsqjrq77Qeh5OxWcVculjc5HwlIy1j8utcCrbgqxO0rGmDSwelwp7tpQLSka8yjK0eBT6bGsipobQOJTvNwsqvDQfTio33DgqgDjhqTkuB8XyTKt6ybicuHMMGhqAn5MFgWipyi1","title":"cvIFieeHRVktF8H6rwmlr0hibxwqG1Am"},"thumb":"http:\/\/www.clker.com\/cliparts\/6\/f\/f\/3\/1197086068917675051egore_Thumb_Up_.svg"},{"thumb":"http:\/\/www.clker.com\/cliparts\/6\/f\/f\/3\/1197086068917675051egore_Thumb_Up_.svg","photolink":{"title":"QvoIi5Jl6l6wSm3S6uLXxRKyOy1l4Su5","description":"LuSsr3PLOVX8v1bhI4lBHu7gb7v6e26jJ77dtcsfUEuQVxkCEDXnFoD04FKmHappnOFtYAkoaN0YRXwrVbwFEN43pS3q3hcwfgSLPyHG68lH0jP0b5W6iU0BVrkvYTE56uCN13r35YFyQtUDy10DTiBWoaVDPXeXuPEhH2e0dj2fDDNrYXljaMOIdg0Xy3AnY7TcFQXVSjlys31QOwgWSf4niurNjiC3DoQYR8gxR75dn3XVJNpRb8ILJs","link":[],"role":"NYI","sponsor":"NYI","id":"1016","category":"NYI"}},{"thumb":"http:\/\/www.clker.com\/cliparts\/6\/f\/f\/3\/1197086068917675051egore_Thumb_Up_.svg","photolink":{"category":"NYI","role":"NYI","link":[],"sponsor":"NYI","id":"1017","description":"g47pSO1IbRgJS7s30RGBMuLuCn7vE2dcGNlBRiaYBSKEkKkoS5bkAtyQxWec1TasC1RfGD3mdPjuHVqiseKtGpHqRGmXcIyPnbeIYIfuCArSx2wNpX23b6frvLofMr4onXPf1pbH1W0TO3KLQKNoAGFR5RuTmfl58JMVGo7Nbfss5Co1PYpoOjDe4w4YyF2B6krpTULkToc7Pf5K1xbDuAwaQLBATR5SJIOd6gyeywl7ciHPWBJe2vyOdi","title":"sF6gntHK1kDa6PaysKPUVAiC2sNxm2p6"}},{"thumb":"http:\/\/www.clker.com\/cliparts\/6\/f\/f

      ......

DELETE /app/movie/112

delete movie by movie id

  • Request

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin, Origin

    • Body

      {"deleted":true}

Device operations

GET /app/device/13

get device by id

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Origin: *
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin, Origin

    • Body

      {"name":"iPad"}

GET /app/device/13/photolinks

get photolinks for device by device id

  • Request

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin, Origin

    • Body

      {"photolinks":[{"category":"NYI","link":[],"sponsor":"NYI","id":"0","role":"NYI","description":null,"title":null},{"sponsor":"NYI","link":[],"role":"NYI","id":"1","category":"NYI","title":null,"description":null},{"category":"NYI","role":"NYI","link":[],"sponsor":"NYI","id":"1017","description":"g47pSO1IbRgJS7s30RGBMuLuCn7vE2dcGNlBRiaYBSKEkKkoS5bkAtyQxWec1TasC1RfGD3mdPjuHVqiseKtGpHqRGmXcIyPnbeIYIfuCArSx2wNpX23b6frvLofMr4onXPf1pbH1W0TO3KLQKNoAGFR5RuTmfl58JMVGo7Nbfss5Co1PYpoOjDe4w4YyF2B6krpTULkToc7Pf5K1xbDuAwaQLBATR5SJIOd6gyeywl7ciHPWBJe2vyOdi","title":"sF6gntHK1kDa6PaysKPUVAiC2sNxm2p6"},{"description":"Se powgiz akarikbu kulered upuego fubowa mup absog me taziv uszowe leko.","title":"Nu jacin mi bumku.","category":"NYI","link":[],"role":"NYI","sponsor":"NYI","id":"1099"},{"link":[],"id":"1105","sponsor":"NYI","role":"NYI","category":"NYI","title":"Ta ogazoga hulefaroj ja.","description":"Kudisoiz ofje vukcogna esebo egoreizu mefitop girketden zoheep mudolti veceghib cezbopoj zunki pakturah azoses kazufi pujlaj."}]}

Photolink operations

POST /app/photolink

create photolink

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {
    "title": "",
    "description": "",
    "mediatype": "xRGnWoMOf1TkGCn0CvRnEblN5IvOCdyV"
}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Origin: *
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin

    • Body

      {"created":true,"id":"1109"}

GET /app/photolink/1109

get Photolink by id

  • Request

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Origin: *
Access-Control-Max-Age: 3600
Vary: Origin, Origin
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"id":"1109","link":[],"sponsor":"NYI","role":"NYI","category":"NYI","title":"","description":""}

Track Motion operations

POST /app/photolink/1109/track_motion

create track motion for photolink by photolink id

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {
    "movie": 0,
    "points": [
        {
            "t": 1,
            "x": 0,
            "y": 2
        },
        {
            "t": 1.1,
            "x": 2,
            "y": 3
        }
    ]
}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin, Origin

    • Body

      {"created":true,"id":"56"}

POST /app/track_motion/56/point

create point in track motion by track motion id

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {
    "x": 0,
    "y": 0,
    "t": 0
}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Vary: Origin, Origin
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"id":"127","created":true}

GET /app/track_motion/56

get track motion by track motion id

  • Request

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin, Origin

    • Body

      {"photolink":{"category":"NYI","link":[],"role":"NYI","sponsor":"NYI","id":"1109","description":"","title":""},"points":[{"y":"2","x":"0","t":"1"},{"t":"1.1","x":"2","y":"3"},{"y":"0","x":"0","t":"0"}]}

POST /app/track_motion/56/click

register a click in track motion id, sending a photolink to user

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {
    "x": 0,
    "y": 0,
    "t": 0
}

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Max-Age: 3600
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin, Origin

    • Body

      {"sent":true}

User operations

POST /app/user

create user

  • Request (application/json)

    • Headers

      X-Auth-Key: ab151c3ed8135147509b32c0a9f3d6381ef0a8c2
X-API-Key: 123

    • Body

      {
    "password": "",
    "username": "",
    "email": ""
}

  • Response 400 (application/json;charset=UTF-8)

    • Headers

      Access-Control-Allow-Origin: *
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key
Vary: Origin

    • Body

      {"errors":[{"path":"\/password","message":"String is too short: 0\/5."},{"path":"\/username","message":"String is too short: 0\/3."},{"path":"\/email","message":"Does not match email format."}]}

GET /app/user/27/photolinks

get photolinks for user by user id

  • Request

    • Headers

      X-Auth-Key: 026a26b104c736e18ba0bbaa2130259643e8d1cf
X-API-Key: 123

  • Response 200 (application/json;charset=UTF-8)

    • Headers

      Vary: Origin, Origin
Access-Control-Max-Age: 3600
Access-Control-Allow-Methods: GET, PUT, POST, DELETE, OPTIONS
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, Authorization, X-Requested-With, X-API-Key, X-Auth-Key

    • Body

      {"photolinks":[{"category":"NYI","role":"NYI","link":[],"sponsor":"NYI","id":"5","description":null,"title":null},{"category":"NYI","link":[],"id":"5","sponsor":"NYI","role":"NYI","description":null,"title":null},{"title":null,"description":null,"id":"5","link":[],"sponsor":"NYI","role":"NYI","category":"NYI"},{"description":null,"title":null,"category":"NYI","link":[],"id":"3","sponsor":"NYI","role":"NYI"},  .....