Versions Compared

Key

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

...

Deck of Cards
idbimRememberMe
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: authorize 

URLhttps://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

optional

string

The id of the application

remember_memandatoryboolSet it to true
Card
labelHTTP Method
 POST
Card
labelDescription
  Once the "remember_me" parameter is set to true, we will get 3 2 extra parameters in the json response (i.e remember_me_token & remember_me_expires_in) The remember_me_expires_in value will be set to 30 days. The client have to save the client_id & remember_me_token in their localStorage, cookie etc. So, for next authentication, they have to use this token as seen in the request json tab. By this way, if this set it is not necessary for the user to enter their credentials every time (i.e the credentials are not required to generate the auth token. Rather the remember_me_token will generate the auth token each time)
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "remember_me_token": "b930e0179baf4f919caeab28328190a3",
    "remember_me": true,
    "userapplication_id" : "test@bimplus.net0106c8baad467c08e26f026852cb7525",
 "password"    "client_id": "test0864b512-1776-4a55-8ee5-2b19d7d9b7ea"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "access_token": "9c1874a62c974dcfa75e0132c423a088d953334fcfe748be9d87e2461f7f3af6",
    "expires_in": 25919997200,
    "client_id": "9fd0bb9d0864b512-570b1776-47194a55-bfae8ee5-93e2f879c19a2b19d7d9b7ea",
    "token_type": "BimPlus"
}