...
If the Browser based REST clients does not select the Content-Type as "application/json", then please mention the content type in the header(Content-Type: application/json)
...
...
...
...
...
...
|  Image Added Service available !
|
| Card |
|---|
| label | URL / Resource / Parameters |
|---|
| Resource: authorize URL: https://api.bimplus.net/v2/ |
|
...
...
| 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"
} |
|
|
...
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
|
Status: 200 OK
|
|
|
...
| Code Block |
|---|
| {
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
} |
|
|
...
2.
...
Receive
...
the
...
authentication token
The token is received in the request
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Implementation Status |
|---|
| Image Added Service available ! |
| Card |
|---|
| label | URL / Resource / Parameters |
|---|
| Resource: authorize URL: https://api.bimplus.net/v2/ |
|
...
...
| 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"
} |
|
|
...
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
|
Status: 200 OK
|
|
|
...
| Code Block |
|---|
| {
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
} |
|
|
...
| Code Block |
|---|
{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
} |
...
3.
...
Request
...
the
...
desired
...
resource
Using the authentication token, the necessary resource can be accessed and the desired action can be performed on that resource using the BimPlus REST API.
Example:
{color:#000000}{*}Get Project List{*}{color}
Get Project List
| Deck of Cards |
|---|
|
| Card |
|---|
| label | Implementation Status |
|---|
| Service available ! |
| Card |
|---|
| label | URL / Resource / Parameters |
|---|
| Resource: projects URL: https://api.bimplus.net/v2/<company>/projects Example: https://api.bimplus.net/v2/bimplus/projects
|
| Card |
|---|
| default | true |
|---|
| label | Description |
|---|
| Get available project list with main properties. |
| Card |
|---|
|
| Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
|
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
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"
} |
|
|
...