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
POST /api/authenticate HTTP/1.1 Host: starling.exploreembedded.com description: If email and password are sent in the post body, 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
[ { "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" } ]