Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
importService
importService

Import Service

...

Anchor
createProjectFromIFC
createProjectFromIFC

Create a new project by importing SketchUp and IFC files
Deck of Cards
idbimCreateProjectFromIFC
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: import 

URLhttps://api.bimplus.net/v2/<team>/import

Examplehttps://api.bimplus.net/v2/bimplus/import

Card
labelDescription

Create a new project by importing SketchUp and IFC files into the team database.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON


Anchor
createSubProjectFromIFC
createSubProjectFromIFC

Create a new sub-project by importing SketchUp and IFC files

...


Anchor
AuthorizationService
AuthorizationService

Authorization Service

...

Anchor
authenticateToken
authenticateToken

Authenticate by requesting and receiving a token
Deck of Cards
idbimAuthenticateToken
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: authorize 

URLhttps://api.bimplus.net/v2/authorize
Examplehttps://api.bimplus.net/v2/authorize

Card
labelDescription

Authenticate by requesting and receiving a token.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
"access_token": "9c1874a62c974dcfa75e0132c423a088"
"expires_in": 2591999
"token_type": "BimPlus"
}


Anchor
getTokenInfo
getTokenInfo

Get token information
Deck of Cards
idbimGetTokenInfo
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: tokeninfo?access_token=<token>

URLhttps://api.bimplus.net/v2/tokeninfo?access_token=<token>

Example

Card
labelDescription

Get information about a specified token.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
    "user_id": "b37b60d4-0f1b-4158-99c4-847254786517",
    "audience": "00000000-0000-0000-0000-000000000000",
    "expires_in": 2271650
}


Anchor
expireToken
expireToken

Revoke / Expire the token

...