Revision as of 17:23, 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

Curl Request

curl -X POST -F "email=yes.sandeep@gmail.com" -F "password=letsbuild17$" \ 'http://starling.exploreembedded.com/api/authenticate'

Curl Response

example with postman

[
  {
    "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"
  }
]

@@ Line 15: / Line 15: @@
 ===Example===
-[[File:Obtain token.PNG|thumbnail|example with postman]]
+====Curl Request====
+<syntaxhighlight>
+curl -X POST -F "email=yes.sandeep@gmail.com" -F "password=letsbuild17$" \ 'http://starling.exploreembedded.com/api/authenticate'
+</syntaxhighlight>
+====Curl Response====
+[[File:Obtain token.PNG|thumbnail|example with postman]]
 <syntaxhighlight lang="javascript">
 [

Difference between revisions of "Starling API"

Revision as of 17:23, 31 December 2015

Contents

Authentication

Obtaining the token

Example

Curl Request

Curl Response