Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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.

bim+ Introduction

Bimplus Introduction 

  • Bimplus bim+ is an open, "All“All-Connect" Connect” platform for connecting people, information and BIM models to build faster. bim+ Bimplus is Open BIM compliant.
  • bim+ Bimplus provides universal access, sharing and connection of relevant building information; enabling seamless collaboration among all people in the project
  • bim+ Bimplus is designed, using the latest Internet computing, cloud technologies, mobile devices and social communication.
  • bim+ Bimplus is the future of the Internet based building Industry.
  • You can find more information about bim+ Bimplus from our
    Newwindowlink
    titleBimplus website
    urlhttps://www.bimplus.net/
  • A bunch of video tutorials are available 
    Newwindowlink
    titlehere
    urlhttphttps://www.bimplus.net/en/User-Guide/
  • What is bim+ Bimplus ?

    Office Powerpoint
    nameWhat is bimplus.pptx
    width550
    height300
  • Benefits of Bim+Bimplus

    Office Powerpoint
    nameIntroducing bimplus.pdf
    width550
    height300

...

Bimplus API

bim+ Bimplus API provides RESTful services for accessing, creating, modifying and deleting different levels of information in a building model on our bim+ Bimplus platform. It connects the building project information to a vast number of developers providing innovative Apps / applications that can operate on the building models and information.There are four types of database operation defined for manipulating the building content. i.e Create, Read, Update, Delete (CRUD) can be performed against the resources(URI, which are building information in our case) which are essentially the building blocks of REST.

...

  • The JSON objects which will be used as the bim+ Bimplus data exchange format will be based on the IFC standard in terms of structure and naming.

...

  • The project slug (which should be provided during the creation of a project) should be provided as part of the URL for accessing all the project relevant resources. This is also necessary to verify the user's user’s access rights on the project in an early stage of processing the API call (before any business data will be touched and any business logic will be executed)

Connect with

...

Bimplus and become a Bimplus compliant developer/partner

  • Newwindowlink
    titleBimplus portal
    urlhttphttps://www-stage.bimplus.net/
    is the first place of contact of the user/developer for using the bim+ platform. It includes a Bimplus platform(stage version). The production version of the portal can be found under 
    Newwindowlink
    titleshophttps://www.bimplus.net
    urlhttphttps://www.bimplus.net/en/Appsproducts/bim-Shop/
    where you can purchase different editions of bim+ Bimplus cloud platform.
    Newwindowlink
    titleHere
    urlhttphttps://www.bimplus.net/en/AppsHome-oxid/bim-Apps/
    you can also find a few critical foundation apps like the bim+ Bimplus Explorer, bim+ Bimplus Viewer and bim+ Bimplus Problem Spotter. The portal takes care of the user registration(developer registration) as well.
  • The bim+ API Bimplus API(stage version url : https://api-stage.bimplus.net/v2) provides an interface for accessing the building information and models. It connects the building project information to a vast number of developers providing innovative Apps / applications that can operate on the building models and information.

The following figure describes the relation between the bim+ Bimplus portal and the API.

Become a bim+ compliant developer/partner

  • Please register
    Newwindowlink
    titlehere
    urlhttphttps://www-stage.bimplus.net/en/open-account/
    for accessing the bim+ Bimplus resources and become a bim+ Bimplus compliant developer and a partner. You will receive an authentication token after the registration.
  • A Team is a tenant/company which work on the projects. The team has to be specified and setup through the
    Newwindowlink
    titlebimplus
    urlhttphttps://www-stage.bimplus.net/
    portal as so called
    Newwindowlink
    titleslugs
    urlhttp://en.wikipedia.org/wiki/Clean_URL#Slug/URL
    to present a
    Newwindowlink
    titleclean URL
    urlhttp://en.wikipedia.org/wiki/Clean_URL/
    . The team slug will be used to know which tenant database to work on.
  • Using the authentication token and the team slug, you can start working with the building projects which you are a member of, using our bim+ Bimplus api.
  • Please find a quick start tutorial Newwindowlinktitlehereurl1.2+Quick+Start+Guide.

bim+ Services

 

Bimplus Services

Bimplus bim+ API provides RESTful services for accessing, creating, modifying and deleting different levels of information in a building model on our bim+ Bimplus platform.

These are the project relevant services available at the moment:

These are the administration relevant services available at the moment:

For further details see the bim+ Bimplus api reference

Client request example:

Composition Setup
 
Deck of Cards
idbimGetProjectList
Card
labelHTTP Method
GET GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: projects 

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

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

Card
labelDescription
Gets  Gets the available project list with main properties.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK