Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: tidy


Note

Help us improve the bim+ Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.

Standard Procedure

httpDevelopers please useglobe showing Europe-Africashield  https://bimplusapi-devstage.mantrobimplus.net/v2 (stage version of Bimplus API) andglobe showing Europe-Africashield  http://bimplusportal-devstage.mantrobimplus.net for the testing purposes because our productive server / (stage version of Shop/Portal) for testing purposes. The production version of the portal is located under  globe showing Europe-Africashield  https://apiportal.bimplus.net is not available to the market yet/    and the base url of the API is different for the production version.

Info

Note: Please use 

Newwindowlink
titleurl
Newwindowlink
title
urlhttps://api.bimplus.net

Generally, the Bim+ Bimplus REST API calls consist of five steps for accessing the resources.

1. Developer Registration

Newwindowlink
titleBimplus portal
urlhttp://www.bimplus.net/
Generally our portal globe showing Europe-Africashield  Allplan Bimplus is the first place of contact of the user /developer for using the bim+ Bimplus platform.

Please , do the developer registrationglobe showing Europe-Africashield  here.

You can find step by step manualhere.

When you have any problems with the registration contact us here .

2.

...

Anchor
authenticateToken
authenticateToken
 Authentication token request

The authentication request for accessing the BimPlus resource should be sent in the JSON format using the OIDC Authorization service. The registered user name and password in the

Newwindowlink
titleBimplus portal
urlhttp://www.bimplus.net/
should be provided here.globe showing Europe-Africashield  Bimplus portal should be provided here.

For example, you can enable the OAuth 2.0 authentication process directly in your REST-client and it will automatically create and refresh tokens when needed.

It is recommended to use browser UI to login and logout with OIDC server. For this process, you can specify discovery URL and retrieve JSON with latest settings there.



Received token should be directly used to access BimPlus resources after receiving it from OIDC. Refreshing and revoking of the tokens are also managed by OIDC, not BimPlus. Old authentication service in BimPlus remains only for backward compatibility and will be removed in 2026.

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, seehere

Composition Setup


Tab Group
deckIdrequestToken


Tab
titleHTTP Method
 POST


Tab
title
Composition Setup
Deck of Cards
idrequestToken
Card
labelHTTP Method

POST

Card
labelURL / Resource / Parameters
  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

(date)

The identifier of the used client

(browser, Apps etc)

application_id

mandatory

string

The id of the application



Tab
title
Card
labelDescription
Obsolete. Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.


Cardtab
defaulttrue
labeltitleRequest


Code Block
borderColorGreen
titleHeaders

Content-Type: application/json


Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
}



Cardtab
labeltitleResponse


Code Block
borderColorGreen
titleStatus

Status: 200 OK


Code Block
borderColorRed
titleJSON
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
}



3. Receive the authentication token 

Obsolete. The token is received in the request.

Deck of Cardstab-group
iddeckIdrequestToken


Cardtab
labeltitleHTTP Method
POST POST


Cardtab
labeltitleURL / Resource / Parameters
  Resource : authorize 

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


Cardtab
labeltitleDescription
Authenticates  Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.


Cardtab
labeltitleRequest


Code Block
borderColorGreen
titleHeaders

Content-Type: application/json


Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
}



Cardtab
defaulttrue
labeltitleResponse


Code Block
borderColorGreen
titleStatus

Status: 200 OK


Code Block
borderColorRed
titleJSON
{
"access_token": "c939ebf5b96646528e0022a35f7a2e679c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
}

where,

access_token

The token to be used in any further API calls within the HTTP headers

expires_in

The remaining lifetime on the access token in seconds

client_id

The identifier of the used client (browser, Apps etc)

token_type

The type of token – currently we use

‚bimplus'

‚bimplus‘



4. Get the team information

The team has to be specified and setup through the 

Newwindowlink
titlebimplus
urlhttp://www.bimplus.net/
globe showing Europe-Africashield  Bimplus portal as so-called
Newwindowlink
titleslugs
urlhttp://en.wikipedia.org/wiki/Clean_URL#Slug/
 to present a
Newwindowlink
titleclean URL
urlhttp://en.wikipedia.org/wiki/Clean_URL/
. globe showing Europe-Africashield  slugs to present aglobe showing Europe-Africashield  clean URL. Slugs are lowercase unique identifiers based on English characters and numbers. The team slug will be used to know which tenant database to work on.

Deck of Cardstab-group
iddeckIdgetTeamInfo


Cardtab
labeltitleHTTP Method
GET GET


Cardtab
defaulttrue
labeltitleURL / Resource / Parameters
  Resource : teams 

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


Cardtab
labeltitleDescription
Get  Get all the available teams.


Cardtab
labeltitleRequest


Code Block
borderColorGreen
titleHeaders

Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e679c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Cardtab
labeltitleResponse


Code Block
borderColorGreen
titleStatus

Status: 200 OK


Code Block
borderColorRed
titleJSON
[2]
0:  {
id: "82884f54-96bf-4e9c-a2fb-44db8379378d"
slug: "nemetschek"
name: "Nemetschek"
owner: "132a78a5-b523-4bf2-8382-7098fac3f803"
totalStorage: 0
storageStats: null
status: "Active"
teamWorksConnection: "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA=="
dataStorageStatus: "Online"
}-
1:  {
id: "7eab1453-a4e7-4d05-983e-031544540e6f"
slug: "bimplus-demo"
name: "BimPlus Demo"
owner: "5592c628-588e-f5c0-b08b-088d43de9209"
totalStorage: 53687091200
storageStats: null
status: "Active"
teamWorksConnection: "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA="
dataStorageStatus: "Online"
}



5. Request the desired resource

Using the authentication token and the team slug, the necessary resource can be accessed and the desired action can be performed on that resource using the Newwindowlinktitleglobe showing Europe-Africashield  Bimplus REST APIurlhttps://nrldev.nemetschek.com/confluence/pages/viewpage.action?pageId=4459171.

For example, we can use this token to get the project list.

Deck of Cardstab-group
iddeckIdexampleGetProjectList


Cardtab
labeltitleHTTP Method
GET GET


Cardtab
labeltitleURL / Resource / Parameters
  Resource : projects 

URLhttps://api-stage.bimplus.net/v2/ <team>/projects

Examplehttps://api-stage.bimplus.net/v2/nemetschek/projects


Cardtab
labeltitleDescription
Get  Get available project list with main properties.


Cardtab
defaulttrue
labeltitleRequest


Code Block
borderColorGreen
titleHeaders

Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e679c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Cardtab
labeltitleResponse


Code Block
borderColorGreen
titleStatus

Status: 200 OK


Code Block
borderColorRed
titleJSON
[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"
}




Tools 

Anchor
Tools
Tools

Plugins for doing REST based calls (REST Client) 

...