...
Generally our portal
Newwindowlink |
---|
title | Allplan Bimplus |
---|
url | https://www-stage.bimplusallplan.net/ | url | https://www-stage.bimplus.netcom/uk_en/products/allplan-bimplus/ |
---|
|
is the first place of contact of the user
/developer for using the Bimplus platform.
Please do the developer registration
Newwindowlink |
---|
title | here |
---|
url | https://connect-stage.allplan.com/bimplus-freemium.html |
---|
|
.
...
You can find step by step manual here.
When you have any problems with the registration contact ushere.
2.
Anchor |
---|
| authenticateToken |
---|
| authenticateToken |
---|
|
Authentication token requestThe 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 |
---|
title | Bimplus portal |
---|
url | https://wwwportal-stage.bimplus.net |
---|
|
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, see here
Deck of Cards |
---|
|
Card |
---|
label | URL / Resource / Parameters |
---|
| Resource: authorize URL: https://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 | The identifier of the used client (browser, Apps etc) | application_id | mandatory | string | The id of the application |
|
Card |
---|
| Obsolete. Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources. |
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
title | Headers |
---|
| Content-Type: application/json
|
Code Block |
---|
| {
"user_id" : "test@bimplus.net",
"password" : "test",
"application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
} |
|
Card |
---|
|
Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
| Status: 200 OK
|
Code Block |
---|
| {
"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.
...
The team has to be specified and setup through the
Newwindowlink |
---|
title | bimplusBimplus portal |
---|
url | https://wwwportal-stage.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.
...
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://doc.bimplusallplan.netcom/display/pages/viewpage.action?pageId=4459171bimpluspublic/Bimplus+API+Reference |
---|
|
.
For example, we can use this token to get the project list.
...