Introduction to Bimplus WebSDK
Bimplus WebSDK library was created with intention to provide easy access to Allplan Bimplus API via simple and easy to use SDK. It contains list of functions which you can call to obtain data from API servers.
Installation
Bimplus WebSDK library is distributed via npm and github repository.
npm registry
Info |
---|
This page is under construction |
Bimplus Web SDK
Bimplus provides a javascript SDK for accessing & manipulating building information stored in the Bimplus platform. The SDK provides a rich set of web-interface tools to view any part or aspect of the 3D model of the given building, showing or hiding specific layers, such as Disciplines or Collisions and other details. It also provides user controls for creating and managing Bimplus projects, collaborating with team/project members, issue tracking etc.
...
...
...
...
Features
The SDK offers various controllers for
- Rendering & visualizing 3D Models/Objects of any size
- Displaying Topologies (objects in a hierarchical tree structure)
- Project related controllers
- Object highlighting
- Setting object transparency
- Sectioning
- Client & Server side(ETag) caching for performance improvement
- Issue Tracking
- Performing CRUD operations on Attachments in projects/objects/issues
- Performing CRUD operations on Comments in Issues
- Performing CRUD operations on Pins (for visualizing issues)
- Slideshows & Slides
- Hyperlinks
Downloading & using the SDK
npm installation
To install package via npm you need to install nodejs and npm . Then in command line run :
npm install bimplus-websdk
Github
Public github repository with latest bundle is here :
The source code for the SDK is located under https://github.com/Bimplusbimplus-admin/Web-SDK. Please go through the "Getting Started" & "Using the SDK" sections of README.MD text.
Web SDK Reference
Attachments
This control could be used for uploading & displaying the attachments.
Deck of Cards | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Comments
Deck of Cards | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Hyperlinks
Deck of Cards | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Issues
Deck of Cards | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Issue List
Usage
Access to Allplan Bimplus API servers is not public, so you need a valid Bimplus account to use one of our servers.
With Bimplus account you obtain also unique application id for your application. If you don't have application id, please contact Allplan company to get one.
Please note that currently we have dev, stage, prod API servers and each of these uses separate accounts. It's not possible to use dev credentials to login into our prod or stage servers. Application id is the same for all api servers, so you can use the same for all our api servers.
In the next sections you can find some basic tutorials how to initialize and use Bimplus WebSDK.
Bimplus WebSdk initialization example
import BimWebSdk from 'bimplus-websdk';
// cache - flag if Bimplus WebSdk should use internal indexeddb cache to store all requests - Dexie plugin is required if it's turned on
// host - choose api server for connection, currently we have these servers - api-dev.bimplus.net, api-stage.bimplus.net, api.bimplus.net
// protocol - choose protocol - http or https
var apiConfig ={ cache: false,
host: "api-dev.bimplus.net",
protocol: "https://"
}
var api = new BimWebSdk.Api(apiConfig);
Authorization example - obsolete
Please note that authorization must be done prior to any other api calls ! It's important to set correct access token into api to provide credentials for other calls.
To successfully login you need to have account in Allplan Bimplus and application id assigned to your application.
Please note that dev, stage and prod api servers are using separate accounts so it's not possible to login to prod via dev credentials.
Application id is the same for all api servers and it identify your application.
api.authorize.post('demoEmail@allplan.com','password', 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX').done(function(data,status,xhr) {
api.setAccessToken(data.access_token);
}).fail(function(data) {
console.error('Login to Bimplus failed');
});
Authorization
Please note, authorization must be done prior to any other api calls! To authorize, the best practise is to use browser UI to OIDC server, using discovery URL. The details about connection (and possible changes in settings) can be manually or automatically retrieved there in JSON format.
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 |
To try calls in postman, you can specify authorization to 'OAuth 2.0' and set it up there.
To successfully login you need to have account in Allplan Bimplus and application id assigned to your application.
Please note that dev, stage and prod api servers are using separate accounts so it's not possible to login to prod via dev credentials.
Application id is the same for all api servers and it identify your application.
Set team by name function example
Here is the simple example how to obtain list of teams and set specific team by name into api. Api must be authorized otherwise this code will fail.
this.setTeamByName = function(teamName){
var tn = teamName ? teamName : this.defaultTeam;
var deferred = $.Deferred();
// prior the first execution of this code we need to login and set valid api access token into Bimplus WebSDK api
return api.teams.get().done(function(data){
var team = data.find(function(d){
return d.name === tn;
});
api.setTeamSlug(team.slug);
deferred.resolve(team.slug,team.id);
}).fail(function(result){
deferred.reject(result);
});
};
Get all projects example
Example how to get list of all projects. Please note that correct access token must be set in api and we must set also the teamslug via api.setTeamSlug(team.slug) call to specify for which team to obtain list of projects
api.projects.get().done(function(data){
deferred.resolve(data);
});
...
id | sdkIssueList |
---|
Card | ||||||
---|---|---|---|---|---|---|
| ||||||
Card | ||||
---|---|---|---|---|
| ||||
Controller: issuesListController Methods: No public methods |
...
label | Template & View |
---|---|
title | The template that has to be loaded |
Template: issuesList.hbs
...