...
| Deck of Cards |
|---|
|
| Card |
|---|
| label | URL / Resource / Parameters |
|---|
| | Resource: authorize URL: https://api-stage.bimplus.net/v2/authorize JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
user_id | mandatory | string | The email address of the user | password | mandatory | string | The user's password | client_id | optional | string | The identifier of the used client (browser, Apps etc) | application_id |
optionalmandatory | string | The id of the application |
|
| Card |
|---|
| | Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| Content-Type: application/json
|
| Code Block |
|---|
| {
"user_id" : "test@bimplus.net",
"password" : "test",
"application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| {
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
} |
|
|
...
| Deck of Cards |
|---|
|
| Card |
|---|
| label | URL / Resource / Parameters |
|---|
| | Resource: authorize URL: https://api-stage.bimplus.net/v2/authorize |
| Card |
|---|
| | Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| Content-Type: application/json
|
| Code Block |
|---|
| {
"user_id" : "test@bimplus.net",
"password" : "test",
"application_id" : "6C12345D9B0C4F3C23ABB5721D098F7B"
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| {
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
"token_type": "BimPlus"
}
|
where, 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‘ |
|
|
4. Get the team information
...
| Deck of Cards |
|---|
|
| Card |
|---|
| default | true |
|---|
| label | URL / Resource / Parameters |
|---|
| | Resource: teams URL: https://api-stage.bimplus.net/v2/teams |
| Card |
|---|
| | Get all the available teams. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e679c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| [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"
} |
|
|
...
| Deck of Cards |
|---|
|
| Card |
|---|
| label | URL / Resource / Parameters |
|---|
| | Resource: projects URL: https://api-stage.bimplus.net/v2/<team>/projects Example: https://api-stage.bimplus.net/v2/nemetschek/projects |
| Card |
|---|
| | Get available project list with main properties. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| Authorization: BimPlus c939ebf5b96646528e0022a35f7a2e679c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| [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"
} |
|
|
...
Tools
Plugins for doing REST based calls (REST Client)
...