Versions Compared

Old Version 336

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 337

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Deck of Cards
idbimAuthenticateToken
Card
labelHTTP Method
 POST
Card
labelURL / Resource / JSON Structure
 Resource: authorize 

URL: https://api.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

optional

string

The id of the application

Card
labelDescription
 Authenticate by requesting and receiving a token.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

 

 

Card
defaulttrue
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
access_token: "e3271e89d8ea474c82745039bc2bed0d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

 

 

 

 

 

 
 
 
Use the client_id "9fd0bb9d-570b-4719-bfae-93e2f879c19a" to generate a token for multiple logins.
 Deck of Cards
idbimAuthenticateToken
 Card
labelHTTP Method
 POST
 Card
labelURL / Resource / JSON Structure
 Resource: authorize 
URL: https://api.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
optional
string
The id of the application
 Card
labelDescription
 Authenticate by requesting and receiving a token.
 Card
defaulttrue
labelRequest
 Code Block
borderColorGreen
titleHeaders
langxml
Content-Type: application/json

 Code Block
borderColorRed
titleJSON
langxml
{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "client_id" : "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
}

 Card
labelResponse
 Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

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

 
 
  • For switching the client, the cross token service can be used. This service is basically used for requesting a disposable temporary token which will be used for authenticating against different clients. Based on the given authentication token the user is identified and a one time token is generated and returned. This one time cross token is valid only for 5 minutes and is used for logging into the given device/client using cross authentication service . As a result of this call, this one time cross token will be removed but the new token which will be generated can be used in the header for the subsequent API calls.
...