Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idrequestToken
Card
labelHTTP Method

POST

Card
labelURL / Resource / Parameters

Resource: authorize 

URLhttps://api.bimplus.net/v2/authorize

Card
labelDescription

Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.

Card
labelRequest
Code Block
borderColorGreen
titleHeaders
Content-Type: application/json


Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
}
Card
defaulttrue
labelResponse
Code Block
borderColorGreen
titleStatus
Status: 200 OK


Code Block
borderColorRed
titleJSON
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
}

where,

access_token

The token to be used in any further API calls within the HTTP headers

expires_in

The remaining lifetime on the access token in seconds

client_id

The identifier of the used client (browser, Apps etc)

token_type

The type of token – currently we use ‚bimplus'

...