Page History

...

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:

(only visible if you have enough access rights)
WEBCLOUD:DEV bimplus Portal

applicatio

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

title	see different Application IDs

Excerpt Include

WEBCLOUD:PROD bimplus Portal

Excerpt Include

WEBCLOUD:STAGE bimplus Portal

Excerpt Include

WEBCLOUD:DEV bimplus Portal

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

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

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
 "user_id" : "test@bimplus.net",
 "password" : "test" ,
 "application_id" : "6C12345D-9B0C-4F3C-23AB-B5721D098F7B"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
"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 12

New Version 13

Key