Difference between revisions of "Starling API"

Line 10: Line 10:
 
  the API returns a token as below
 
  the API returns a token as below
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
{| class="wikitable"
 +
|-
 +
! http verb !! Request !! Response!!Description
 +
|-
 +
| POST
 +
|| /api/authenticate
 +
|| token
 +
||Pass email and password as body parameter to obtain a web token
 +
|-
 +
 +
|}
  
 
===Response===
 
===Response===

Revision as of 16:58, 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.

Obtaining the token

Request

  1. POST /api/authenticate HTTP/1.1
  2. Host: starling.exploreembedded.com
  3. description: If email and password are sent in the post body,
  4.  the API returns a token as below
http verb Request Response Description
POST /api/authenticate token Pass email and password as body parameter to obtain a web token

Response

  1. [
  2.   {
  3.     "id": "4",
  4.     "user_id": "2",
  5.     "name": "EE unit 4",
  6.     "product_id": "STAR0004",
  7.     "location": "",
  8.     "configuration":{
  9.       "lines":"2" ,
  10.       "brightness":"100",
  11.       "current_message":"hello world",
  12.       "scroll_speed":"6",
  13.       "font":"arial"
  14.     },
  15.     "created_at": "2015-12-28 14:27:07",
  16.     "updated_at": "2015-12-28 14:27:07"
  17.   }
  18. ]
Retrieved from "https://exploreembedded.com/wiki/index.php?title=Starling_API&oldid=6552"