Versions Compared

Old Version 19

changes.mady.by.user Eduard Mrazek

Saved on

compared with

New Version 20

changes.mady.by.user Eduard Mrazek

Saved on

Key

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

...

Deck of Cards
idbimAuthenticateToken


Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: authorize 

URL: https://api-stage.bimplus.net/v2/authorize

JSON Structure: 

Name

Mandatory / Optional

Type

Description

user_id

mandatory

string

The email address of the user

password

mandatory

string

The user's password

client_id

optional

string

The identifier of the used client

application_id

mandatory

string

The id of the application

Expand
titleSee Details

Application ID is mandatory on bimplus Bimplus API on Dev, Stage and Stage Prod since 19.10.2017. On Prod it is also soon needed.
to To get your application id the contact bimplus developement Bimplus development team


remember_meoptionalboolOption for saving the user's credentials



Card
labelHTTP Method
 POST


Card
labelDescription
 Authorizes a user and returns a token for further API calls.

Please, use the client_id from the request and regenerate the token (using the same API call with client_id as the additional parameter) for having the possibility to login multiple times at the same time. For more information, see here

Response for the token validity is in seconds, means the token validity is 2 hours by default and remember me token 4 weeks resp. 28,9 days exactly.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test" ,
 "application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}



...