Page History

...

Anchor

	authenticateToken
	authenticateToken

Authorizes a user and returns a token for further API calls

Deck of Cards

id	bimAuthenticateToken

Card

label	HTTP Method

POST

Card

default	true
label	URL / 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

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

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"
}

Card

Deck of Cards

Anchor

	getTokenInfo
	getTokenInfo

Get token information

Deck of Cards

id	bimGetTokenInfo

Card

label	HTTP Method

GET

Card

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: tokeninfo?access_token=<token>

URL: https://api.bimplus.net/v2/tokeninfo?access_token=<token>

Example:

Card

label	Description

...

Get information about a specified token(if the specified token exists and not expired).

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "user_id": "b37b60d4-0f1b-4158-99c4-847254786517",
    "audience": "00000000-0000-0000-0000-000000000000",
    "expires_in": 2271650

}

where,

Name	Type	Description
user_id	The unique user id to be used for any further API calls.
expires_in	The remaining lifetime on the access token in seconds
audience	In our case the id of the client (Mobile app, Browser …)

...

Card

Deck of Cards

Anchor

	getCrossToken
	getCrossToken

Request a cross token

Deck of Cards

id	bimGetCrossToken

Card

label	HTTP Method

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: cross-token

URL: https://api.bimplus.net/v2/cross-token

Card

Card

label	Description

...

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.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
cross_token: "b392cee4d0044ef681fa911772668cf9"
expires_in: 299
token_type: "BimPlus"
}

where,

Name	Type	Description
cross_token	string	The temporary token which will be used for cross-authenticate
expires_in	string	The remaining lifetime on the access token in seconds
token_type	string	Type of the token which will be used as part of the header

...

Card

Deck of Cards

Anchor

	crossAuthenticate
	crossAuthenticate

Cross Authenticate by using cross token

Deck of Cards

id	bimCrossAuthenticate

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: cross-authorize

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
cross_token	mandatory	string	The temporary token which will be used for cross-authenticate
client_id	optional	string	The identifier of the used client
team_id	optional	string	The id of the team
project_id	optional	string	The id of the project
application_id	optional	string	The id of the application

...

card

Card

label	Description

Based on the one time cross token, the user will be identified and logged in to the given device/client. The one time cross token will be removed but the new token which will be generated as a result of this call be used in the header for the subsequent API calls.

The team_id and project_id information can be provided as part of the call, if the user wants to work on or display(viewer) a particular team or an project.

...

deck

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
"cross_token": "b392cee4d0044ef681fa911772668cf9"
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

Anchor

	expireToken
	expireToken

Revoke / Expire the token

Deck of Cards

id	bimExpireToken

Card

label	HTTP Method

GET

Card

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: revoke?token=<token>

URL: https://api.bimplus.net/v2/revoke?token=<token>

Example:

...

Card

label	Description

...

The specified token will expire immediately.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

Deck of Cards

Anchor

	userService
	userService

...

Anchor

	createUser
	createUser

Create a new user

Deck of Cards

id	bimCreateUser

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: users

URL: https://api.bimplus.net/v2/users

Example: https://api.bimplus.net/v2/users

JSON Structure:

Name	Mandatory / Optional	Type	Description
email	mandatory	string	Email of the user
status	optional	will be ignored	The status of the account (Active / Inactive)
password	mandatory	string	Password of the user

...

Card

label	Description

...

Creates a new user account.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

Card

Deck of Cards

Anchor

	getUserInfo
	getUserInfo

Get information about the user

Deck of Cards

id	bimGetUserInfo

Card

label	Description

Get information about a specified user.

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/users/<user_id>

Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

...

Card

Card

label	Description

...

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

Card

Deck of Cards

Anchor

	updateUser
	updateUser

Update information about the user

Deck of Cards

id	bimUpdateUserInfo

Card

label	HTTP Method

...

Card

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/users/<user_id>

Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure:

Name	Mandatory / Optional	Type	Description
email	mandatory	string	Email of the user
status	mandatory	string	The status of the account (Active / Inactive)
password	mandatory	string	Password of the user

Card

Card

label	Description

...

Update information about a specified user.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

...

Anchor

	getCurrentUserInfo
	getCurrentUserInfo

Get information about the currently logged in user

Deck of Cards

id	bimGetCurrentUserInfo

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

URL: https://api.bimplus.net/v2/user

...

Card

label	Description

...

Get information about the currently logged in user.

...

cardcard

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

Deck of Cards

Anchor

	teamService
	teamService

...

Anchor

	createTeam
	createTeam

Create a new team and its related database

Deck of Cards

id	bimCreateNewTeam

Card

label	HTTP Method

POST

...

Card

default	true
label	URL / Resource / JSON Structure

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 249

New Version 250

Key

Authorizes a user and returns a token for further API calls

Get token information

Request a cross token

Cross Authenticate by using cross token

Revoke / Expire the token

Create a new user

Get information about the user

Update information about the user

Get information about the currently logged in user

Create a new team and its related database