Versions Compared

Key

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

...

Authorization Service

...

Anchor
authenticateToken
authenticateToken

...

Anchor
rememberMe
rememberMe

Get "remember me" token

...

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 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
langxml
titleHeaders
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "user_id" : "test@bimplus.net",
    "password" : "test",
    "remember_me" : "true",
    "application_id": "0106c8baad467c08e26f026852cb7525",
    "client_id": "0864b512-1776-4a55-8ee5-2b19d7d9b7ea"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "access_token": "35eb2b5e94b54d5aafa6b6a7b6e8de01",
    "expires_in": 28799,
    "application_id": "0106c8baad467c08e26f026852cb7525",
    "client_id": "0864b512-1776-4a55-8ee5-2b19d7d9b7ea",
    "remember_me": true,
    "remember_me_token": "b930e0179baf4f919caeab28328190a3", 
    "remember_me_expires_in" : 2591999 
}
Get "remember me" token

Anchor
#rememberMeLogin
#rememberMeLogin

Deck of Cards
idbimRememberMeLogin
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: authorize 

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

JSON Structure

 

Name

Mandatory / Optional

Type

Description

remember_memandatoryboolSet it to true
remember_me_tokenmandatorystringThe "remember me" token

client_id

mandatory

string

The identifier of the used client

application_id

optional

string

The id of the application

Card
labelHTTP Method

 POST

Card
labelDescription

It is not necessary for the user to enter the credentials each time. Instead, do it only if required, together with requesting the "remember me" token, and than use this remember token to generate the authentication token each time.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
    "remember_me" : "true",
    "remeber_me_token": "b930e0179baf4f919caeab28328190a3",
    "application_id": "0106c8baad467c08e26f026852cb7525",
    "client_id": "0864b512-1776-4a55-8ee5-2b19d7d9b7ea",
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
    "access_token" : "e3a212b8f70e4b85b0ed826de7f775f6",
    "expires_in" : 28799,
    "application_id": "0106c8baad467c08e26f026852cb7525",
    "client_id": "0864b512-1776-4a55-8ee5-2b19d7d9b7ea",
    "token_type": "BimPlus"
}