Page History

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

Standard Procedure

Info

Note: Please use

Newwindowlink

title	http://bimplus-dev.mantro.net
url	http://bimplus-dev.mantro.net

for the testing purposes because our productive server

Newwindowlink

title	https://api.bimplus.net
url	https://api.bimplus.net

is not available to the market yet.

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

1. Developer Registration

Newwindowlink

title	Bimplus portal
url	http://www.bimplus.net/

is the first place of contact of the user/developer for using the bim+ platform. Please do the developer registration here.

2. Authentication token request

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

Newwindowlink

title	Bimplus portal
url	http://www.bimplus.net/

should be provided here.

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

Composition Setup

Deck of Cards

id	requestToken

Card

label	HTTP Method

POST

Card

label	URL / Resource / Parameters

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 (browser, Apps etc)
application_id	optional	string	The id of the application

where application_id will be one of the following:

Art-No	App	Platform	UID
Editions
AM00050000	bim+ Starter Edition	Cloud	df2dbfa44a2b89704d38e07175be8298

AM00050050	bim+ Business Edition	Cloud	2efa4c5a58b189e04f0af8879d6c3fca

AM00050100	bim+ Enterprise Edition	Cloud	685b24cf716e211e64f126d5347074e3

BTW
AM00050200	bim+ TeamWorks	Win	f6c5e0004f0ae73c485324a900a28a14

bim+ Apps
AM0005311	bim+ Explorer	iPad	c08181961a0cf078d740f402a18610a1
AM0005321	bim+ MyHouse Photo	iPad	13f8972af21a76036717f0e51db64184
AM0005331	bim+ Problem Spotter	iPad	13fe742a744959f7f849c30b63bcc4c0
AM0005341	bim+ Viewer	iPad	c087f3e4f242e974e6ca99f74cc4f6a0

3rd Party Apps

bim+ Services
AM00055000	bim+ WebViewer	Browser

Card

label	Description

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

Card

default	true
label	Request

Code Block

borderColor	Green
title	Headers

Content-Type: application/json

Code Block

borderColor	Red
title	JSON

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

Card

label	Response

Code Block

borderColor	Green
title	Status

Status: 200 OK

Code Block

borderColor	Red
title	JSON

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

3. Receive the authentication token

The token is received in the request.

Deck of Cards

id	requestToken

Card

label	HTTP Method

POST

Card

label	URL / Resource / Parameters

Resource: authorize

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

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers

Content-Type: application/json

Code Block

borderColor	Red
title	JSON

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

Card

default	true
label	Response

Code Block

borderColor	Green
title	Status

Status: 200 OK

Code Block

borderColor	Red
title	JSON

{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"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'

4. Get the team information

The team has to be specified and setup through the

Newwindowlink

title	bimplus
url	http://www.bimplus.net/

portal as so-called

Newwindowlink

title	slugs
url	http://en.wikipedia.org/wiki/Clean_URL#Slug/

to present a

Newwindowlink

title	clean URL
url	http://en.wikipedia.org/wiki/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 Cards

id	getTeamInfo

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / Parameters

Resource: teams

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

Card

label	Description

Get all the available teams.

Card

label	Request

Code Block

borderColor	Green
title	Headers

Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e67
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status

Status: 200 OK

Code Block

borderColor	Red
title	JSON

[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

Newwindowlink

title	Bimplus REST API
url	https://nrldev.nemetschek.com/confluence/pages/viewpage.action?pageId=4459171

.

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

Deck of Cards

id	exampleGetProjectList

Card

label	HTTP Method

GET

Card

label	URL / Resource / Parameters

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

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

Card

label	Description

Get available project list with main properties.

Card

default	true
label	Request

Code Block

borderColor	Green
title	Headers

Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e67
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status

Status: 200 OK

Code Block

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

Tools

Anchor

	Tools
	Tools

Plugins for doing REST based calls (REST Client)

Chrome --> Advanced REST client, Postman - REST client, Simple REST client

Firefox --> RESTClient

For validating or formatting JSON --> http://jsonlint.com/

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 139

New Version 140

Key

Standard Procedure

1. Developer Registration

2. Authentication token request

3. Receive the authentication token

4. Get the team information

5. Request the desired resource

Tools