Page History

...

Deck of Cards

id	bimAuthenticateToken

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: authorize

URL: https://api.bimplus.net/v2/<company>/authorize
Example: https://api.bimplus.net/v2/bimplus/projectsauthorize

Card

label	Description

Authenticate by requesting and receiving a token.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Code Block

borderColor	Red
lang	xml
title	JSON

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

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
"token_type": "BimPlus"
}

...

Deck of Cards

id	bimGetTokenInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: tokeninfo?access_token=<token>

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

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

Card

label	Description

Get information about a specified token.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id"user_id": "2d703abeb37b60d4-b4f90f1b-407c4158-af5399c4-a39c5b7ba872847254786517",
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id"audience": "c480cc5400000000-aec40000-4bef0000-8d350000-93bb090e1aba000000000000",
name: "0811-Wohnhaus Kraus - Carport1""expires_in": 2271650
}

Revoke / Expire the token

Deck of Cards

id	bimExpireToken

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: revoke?token=<token>

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

Card

label

Card

label	Description

The specified token will expire immediately.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

User Management Service

Anchor

	UserService
	UserService

...

Deck of Cards

id	bimCreateUser

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: users

URL: https://api.bimplus.net/v2/<company>/users
Example: https://api.bimplus.net/v2/bimplus/projectsusers

JSON Structure:

Name	Type	Description
email	string	Email of the user
status	string
password	string	Password of the user

Card

label	Description

Creates a new user account.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 OKCreated

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
idid": "c480cc54b8615afc-aec499cc-4bef4bcd-8d35b0ca-93bb090e1abaff0593ce15c6"
name,
    "email": "0811-Wohnhaus Kraus - Carport1"test@bimplus.net",
    "status": "Active"
}

Get information about the user

Deck of Cards

id	bimGetUserInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

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

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

Card

label	Description

Get information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
idid": "2d703abeb8615afc-b4f999cc-407c4bcd-af53b0ca-a39c5b7ba872ff0593ce15c6",
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}"email": "test@bimplus.net",
    "status": "Active"
}

Update information about the user

Deck of Cards

id	bimUpdateUserInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/<company>/users/<user_id>b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Example: https://api.bimplus.net/v2/bimplususers/projects

JSON Structure:

Name	Type	Description
email	string	Email of the user
status	string
password	string	Password of the user

Card

label	Description

Update information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK


lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Get information about the currently logged in user

Deck of Cards

id	bimGetCurrentUserInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: user

URL: https://api.bimplus.net/v2/<company>/user

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

Card

label	Description

Get information about the currently logged in user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
idid": "2d703abeb8615afc-b4f999cc-407c4bcd-af53b0ca-a39c5b7ba872ff0593ce15c6",
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}"email": "test@bimplus.net",
    "status": "Active"
}

Team Management Service

Anchor

	TeamService
	TeamService

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Revoke / Expire the token

User Management Service

Get information about the user

Update information about the user

Get information about the currently logged in user

Team Management Service