Line 25: Line 25:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
====Curl Response====
 
 
[[File:Obtain token.PNG|thumbnail|example with postman]]
 
[[File:Obtain token.PNG|thumbnail|example with postman]]
<syntaxhighlight lang="javascript">
 
[
 
  {
 
    "id": "4",
 
    "user_id": "2",
 
    "name": "EE unit 4",
 
    "product_id": "STAR0004",
 
    "location": "",
 
    "configuration":{
 
      "lines":"2" ,
 
      "brightness":"100",
 
      "current_message":"hello world",
 
      "scroll_speed":"6",
 
      "font":"arial"
 
    },
 
    "created_at": "2015-12-28 14:27:07",
 
    "updated_at": "2015-12-28 14:27:07"
 
  }
 
]
 
</syntaxhighlight>
 

Revision as of 17:33, 31 December 2015

Authentication

Starling API works on javascript web-tokens. The default validity for the tokens is 1 year. It will be changed to shorter duration soon.

Base URL for all requests: http://starling.exploreembedded.com

Obtaining the token

http verb Request Response Description
POST /api/authenticate token Pass email and password as body parameter to obtain a web token

Example with CURL

curl -X POST -F "email=your@email.com" -F "password=password" \ 
'http://starling.exploreembedded.com/api/authenticate'
{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIyIiwiaXNzIjoiaHR0c
DpcL1wvc3RhcmxpbmcuZXhwbG9yZWVtYmVkasdfdsfNvbVwvYXBpXC9hdXRoZW50.
iwiZXhwIjoiMTQsdfeaeSEFEA0NiIsIm5iZiI6IjE0NTE1NjMwNDYiLCJqdGkiOiI4asdfew}
example with postman