...
The authentication request for accessing the BimPlus resource should be sent in the JSON format using the Authorization service. The registered user name and password in the
Newwindowlink |
---|
title | Bimplus portal |
---|
url | http://www.bimplus.net/ |
---|
|
should be provided here.
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
Deck of Cards |
---|
|
Card |
---|
label | URL / Resource / Parameters |
---|
| Resource: authorize URL: https://api.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 | mandatory optional | string | The identifier of the used client (browser, Apps etc) | application_id | optional | string | The id of the application |
where application_id will be one of the following:
Art-No
| App | Platform | UID |
---|
Editions
| | | |
---|
AM00050000 | bim+ Starter Edition | Cloud
| df2dbfa44a2b89704d38e07175be8298 | | | | | AM00050050 | bim+ Business Edition | Cloud
| 2efa4c5a58b189e04f0af8879d6c3fca | | | | | AM00050100 | bim+ Enterprise Edition | Cloud
| 685b24cf716e211e64f126d5347074e3 | | | | | BTW
| | | |
---|
AM00050200 | bim+ TeamWorks
| Win
| f6c5e0004f0ae73c485324a900a28a14 | | | | | bim+ Apps
| | | |
---|
AM0005311
| bim+ Explorer | iPad | c08181961a0cf078d740f402a18610a1 | AM0005321 | bim+ MyHouse Photo | iPad | 13f8972af21a76036717f0e51db64184 | AM0005331 | bim+ Problem Spotter | iPad | 13fe742a744959f7f849c30b63bcc4c0 | AM0005341 | bim+ Viewer | iPad | c087f3e4f242e974e6ca99f74cc4f6a0 | | | | | 3rd Party Apps
| | | |
---|
| | | | bim+ Services
| | | |
---|
AM00055000 | bim+ WebViewer
| Browser
| | | | | |
|
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",
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
} |
|
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"
} |
|
|
3. Receive the authentication token
...
Deck of Cards |
---|
|
Card |
---|
label | URL / Resource / Parameters |
---|
| Resource: authorize URL: https://api.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",
"client_id" : "1FD44C0E-DCB4-11E2-A114-67286288709B"
} |
|
Card |
---|
| Code Block |
---|
borderColor | Green |
---|
title | Status |
---|
|
Status: 200 OK
|
Code Block |
---|
|
{
"access_token": "c939ebf5b96646528e0022a35f7a2e679c1874a62c974dcfa75e0132c423a088",
"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 | string | The identifier of the used client (browser, Apps etc) | token_type | The type of token – currently we use ‚bimplus' |
|
|
...