...
Note |
---|
Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page. |
Standard Procedure
Info | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Developers please use
|
Generally, the Bimplus REST API calls consist of five steps for accessing the resources.
1. Developer Registration
Generally our portal
Newwindowlink | ||||
---|---|---|---|---|
|
Please do the developer registration
Newwindowlink | ||||
---|---|---|---|---|
|
...
.
You can find step by step manual here.
When you have any problems with the registration contact ushere.
2.
Anchor | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
|
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.
Environment | Discovery URL |
---|---|
Development | https://api-dev.bimplus.net/v2/.well-known/openid-configuration |
Stage | https://api-stage.bimplus.net/v2/.well-known/openid-configuration |
Production | https://api.bimplus.net/v2/.well-known/openid-configuration |
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
Wiki Markup |
---|
Composition Setup |
Wiki Markup |
---|
{deck:id=requestToken} |
Wiki Markup |
---|
{card:label=HTTP Method} |
POST
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{card:label=URL / Resource / Parameters} |
Deck of Cards | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
...
|
...
Art-No
...
App
...
Platform
...
UID
...
Editions
...
...
...
...
AM00050000
...
Bimplus Starter Edition
...
Cloud
...
df2dbfa44a2b89704d38e07175be8298
...
...
...
...
...
AM00050050
...
Bimplus Business Edition
...
Cloud
...
2efa4c5a58b189e04f0af8879d6c3fca
...
...
...
...
...
AM00050100
...
Bimplus Enterprise Edition
...
Cloud
...
685b24cf716e211e64f126d5347074e3
...
...
...
...
...
BTW
...
...
...
...
AM00050200
...
Bimplus TeamWorks
...
Win
...
f6c5e0004f0ae73c485324a900a28a14
...
...
...
...
...
Bimplus Apps
...
...
...
...
AM0005311
...
Bimplus Explorer
...
iPad
...
c08181961a0cf078d740f402a18610a1
...
AM0005321
...
Bimplus MyHouse Photo
...
iPad
...
...
AM0005331
...
Bimplus Problem Spotter
...
iPad
...
13fe742a744959f7f849c30b63bcc4c0
...
AM0005341
...
Bimplus Viewer
...
iPad
...
c087f3e4f242e974e6ca99f74cc4f6a0
...
...
...
...
...
3rd Party Apps
...
...
...
...
...
...
...
...
Bimplus Services
...
...
...
...
AM00055000
...
Bimplus WebViewer
...
Browser
...
...
...
...
...
|
...
Wiki Markup |
---|
{card:label=Description} |
|
Wiki Markup |
---|
{card} |
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{card:label=Request|default=true}
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
|
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{deck} |
3. Receive the authentication token
Obsolete. The token is received in the request.
Wiki Markup |
---|
{deck:id=requestToken} |
Wiki Markup |
---|
{card:label=HTTP Method} |
POST
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{card:label=URL / Resource / Parameters} |
Deck of Cards | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
| ||||||||||
Wiki Markup | ||||||||||
|
Wiki Markup |
---|
{card:label=Description} |
...
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
|
Wiki Markup |
---|
{card} |
| |||||||||||||||||||||||||||
Wiki Markup | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{card:label=Response|default=true}
|
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{deck} |
4. Get the team information
The team has to be specified and setup through the
Newwindowlink | ||||
---|---|---|---|---|
|
Newwindowlink | ||||
---|---|---|---|---|
|
Newwindowlink | ||||
---|---|---|---|---|
|
Wiki Markup |
---|
{deck:id=getTeamInfo} |
Wiki Markup |
---|
{card:label=HTTP Method} |
GET
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{card:label=URL / Resource / Parameters|default=true} |
Deck of Cards | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
| ||||||||||||
Wiki Markup | ||||||||||||
|
Wiki Markup |
---|
{card:label=Description} |
...
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
|
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{deck} |
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 | ||||
---|---|---|---|---|
|
For example, we can use this token to get the project list.
Wiki Markup |
---|
{deck:id=exampleGetProjectList} |
Wiki Markup |
---|
{card:label=HTTP Method} |
GET
Wiki Markup |
---|
{card} |
Wiki Markup |
---|
{card:label=URL / Resource / Parameters} |
Deck of Cards | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
|
Wiki Markup |
---|
{card:label=Description} |
...
|
Wiki Markup |
---|
{card} |
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{card:label=Request|default=true}
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
| ||||||||||||||||||||||
Wiki Markup | ||||||||||||||||||||||
|
Wiki Markup |
---|
{card} |
Wiki Markup | ||
---|---|---|
{deck
|
Tools
Anchor | ||||
---|---|---|---|---|
|
Plugins for doing REST based calls (REST Client)
...