Page History

...

Authorization Service

...

Anchor

	authenticateToken
	authenticateToken

...

Deck of Cards

id	bimAuthenticateToken

Card

default	true
label	URL / 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	optional	string	The id of the application
remember_me	optional	bool	Option for saving the user's credentials

Card

label	HTTP Method

POST

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

...

Deck of Cards

id	bimExpireToken

Card

default	true
label	URL / Resource / JSON Structure

Resource: authorize

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

Card

label	HTTP Method

DELETE

Card

label	Description

The specified token will expire immediately.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	rememberMe
	rememberMe

How remember me works

Deck of Cards

id	bimRememberMe

Card

default	true
label	URL / 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	optional	string	The id of the application
remember_me	mandatory	bool	Set it to true

Card

label	HTTP Method

POST

Card

label	Description

Once the "remember_me" parameter is set to true, we will get 3 extra parameters in the json response (i.e remember_me_token)

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Authorization Service

How remember me works