Versions Compared

Old Version 143

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 144

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

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

{composition-setup}{}
Wiki Markup
Composition Setup
Wiki Markup
{deck:id=requestToken}
Wiki Markup
{card:label=HTTP Method}

POST

Wiki Markup
{card}
 Deck of Cards
idrequestToken
 Card
labelHTTP Method
POST
 Card
{card:label=URL / Resource / Parameters}
 Card
labelURL / Resource / Parameters
 Wiki Markup
Resource: authorize 
URL: https://api.bimplus.net/v2/authorize
...
 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 
 13f8972af21a76036717f0e51db64184 
 AM0005331 
 Bimplus Problem Spotter 
 iPad 
 13fe742a744959f7f849c30b63bcc4c0 
 AM0005341 
 Bimplus Viewer 
 iPad 
 c087f3e4f242e974e6ca99f74cc4f6a0 
 
 
 
 
 3rd Party Apps 
 
 
 
 
 
 
 
 Bimplus Services 
 
 
 
 AM00055000 
 Bimplus WebViewer 
 Browser 
 
 
 
 
 
 Card
 Card
labelDescription
 Wiki Markup
{card}
{card:label=Description}
 Wiki Markup
Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.
 Wiki Markup
{card}
 Card
{card:label=Request|default=true}
 Card
defaulttrue
labelRequest
 Wiki Markup
 Code Block
borderColorGreen
titleHeaders
Content-Type: application/json

...
 Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}
 Wiki Markup
{card}
 Card
{card:label=Response}
 Card
labelResponse
 Wiki Markup
 Code Block
borderColorGreen
titleStatus
Status: 200 OK

...
 Code Block
borderColorRed
titleJSON
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
}
{}
 Wiki Markup
 Card
 Wiki Markup
{}
 Deck of Cards
3. Receive the authentication token 
The token is received in the request.
 Wiki Markup
{deck:id=requestToken}
 Wiki Markup
{card:label=HTTP Method}
POST
 Wiki Markup
{card}
 Deck of Cards
idrequestToken
 Card
labelHTTP Method
POST
 Card
{card:label=URL / Resource / Parameters}
 Card
labelURL / Resource / Parameters
 Wiki Markup
Resource: authorize 
URL: https://api.bimplus.net/v2/authorize
 Wiki Markup
{card}
 Card
{card:label=Description}
 Card
labelDescription
 Wiki Markup
Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.
 Wiki Markup
{card}
 Card
{card:label=Request}
 Card
labelRequest
 Wiki Markup
 Code Block
borderColorGreen
titleHeaders
Content-Type: application/json

...
 Code Block
borderColorRed
titleJSON
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}
 Wiki Markup
{card}
 Card
{card:label=Response|default=true}
 Card
defaulttrue
labelResponse
 Wiki Markup
 Code Block
borderColorGreen
titleStatus
Status: 200 OK

...
 access_token 
 The token to be used in any further API calls within the HTTP headers 
 expires_in 
 The remaining lifetime on the access token in seconds 
 client_id 
 The identifier of the used client (browser, Apps etc) 
 token_type 
 The type of token – currently we use ‚bimplus‘ 
{}
 Wiki Markup
 Card
 Wiki Markup
{}
 Deck of Cards
4. Get the team information
The team has to be specified and setup through the 
 Newwindowlink
titlebimplus
urlhttp://www.bimplus.net/
 portal as so-called 
 Newwindowlink
titleslugs
urlhttp://en.wikipedia.org/wiki/Clean_URL#Slug/
 to present a 
 Newwindowlink
titleclean URL
urlhttp://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.
 Wiki Markup
{deck:id=getTeamInfo}
 Wiki Markup
{card:label=HTTP Method}
GET
 Wiki Markup
{card}
 Deck of Cards
idgetTeamInfo
 Card
labelHTTP Method
GET
 Card
{card:label=URL / Resource / Parameters|default=true}
 Card
defaulttrue
labelURL / Resource / Parameters
 Wiki Markup
Resource: teams 
URL: https://api.bimplus.net/v2/teams
 Wiki Markup
{card}
 Card
{card:label=Description}
 Card
labelDescription
 Wiki Markup
Get all the available teams.
 Wiki Markup
{card}
 Card
{card:label=Request}
 Card
labelRequest
 Wiki Markup
 Code Block
borderColorGreen
titleHeaders
Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e67
Content-Type: application/json

 Wiki Markup
{card}
 Card
{card:label=Response}
 Card
labelResponse
 Wiki Markup
 Code Block
borderColorGreen
titleStatus
Status: 200 OK

...
unmigrated-inline-wiki-markup
 Code Block
borderColorRed
titleJSON
[2]
0:  {
id: "82884f54-96bf-4e9c-a2fb-44db8379378d"
slug: "nemetschek"
name: "Nemetschek"
owner: "132a78a5-b523-4bf2-8382-7098fac3f803"
totalStorage: 0
storageStats: null
status: "Active"
teamWorksConnection: "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA=="
dataStorageStatus: "Online"
}-
1:  {
id: "7eab1453-a4e7-4d05-983e-031544540e6f"
slug: "bimplus-demo"
name: "BimPlus Demo"
owner: "5592c628-588e-f5c0-b08b-088d43de9209"
totalStorage: 53687091200
storageStats: null
status: "Active"
teamWorksConnection: "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA="
dataStorageStatus: "Online"
}
{
}
 Card
{}
 Wiki Markup
 Deck of Cards
5. Request the desired resource
...
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}
 Deck of Cards
idexampleGetProjectList
 Card
labelHTTP Method
GET
 Card
{card:label=URL / Resource / Parameters}
 Card
labelURL / Resource / Parameters
 Wiki Markup
Resource: projects 
URL: https://api.bimplus.net/v2/<team>/projects
Example: https://api.bimplus.net/v2/nemetschek/projects
 Wiki Markup
{card}
 Card
{card:label=Description}
 Card
labelDescription
 Wiki Markup
Get available project list with main properties.
 Wiki Markup
{card}
 Card
{card:label=Request|default=true}
 Card
defaulttrue
labelRequest
 Wiki Markup
 Code Block
borderColorGreen
titleHeaders
Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e67
Content-Type: application/json

 Wiki Markup
{card}
 Card
{card:label=Response}
 Card
labelResponse
 Wiki Markup
 Code Block
borderColorGreen
titleStatus
Status: 200 OK

...
 Code Block
borderColorRed
titleJSON
[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}
{}
 Wiki Markup
 Card
 Wiki Markup
{}
 Deck of Cards
Tools 
 Anchor
Tools
Tools

 Plugins for doing REST based calls (REST Client) 
...