...
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)
...
Card |
---|
label | Implementation Status |
---|
|
Image Removed Service available ! |
...
label | URL / Resource / Parameters |
---|
Resource: authorize
...
:id=bimRequestToken}
{card:label=Implementation Status}
!check.gif|border=1! Service available \!
{card}
{card:label=HTTP Method}
POST
{card}
{card:label=URL / Resource / Parameters}
*Resource*: authorize
*URL*: {nolink:https://api.bimplus.net/v2/}authorize |
...
Card |
---|
default | true |
---|
label | Description |
---|
|
Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources. |
...
...
borderColor | Green |
---|
title | Headers |
---|
...
{card}{card:label=Description}Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.
{card}{card:label=Request|default=true}
{code:title=Headers|borderColor=Green}
Content-Type: application/json |
...
{code}
\\
{code:title=JSON|borderColor=Red}{
"user_id" : "test@bimplus.net",
"password" : "test"
} |
...
...
borderColor | Green |
---|
title | Status |
---|
{code}
{card}
{card:label=Response}
{code:title=Status|borderColor=Green}
Status: 200 OK |
...
{code}
\\
{code:title=JSON|borderColor=Red}{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
|
...
}{code}
{card}
{deck}
h3. 2. Receive the |
...
The token is received in the request
...
authentication token
The token is received in the request
{deck:id=bimReceiveToken}
\\
{card:label=Implementation Status}
!check.gif|border=1! Service available \!
{card}
\\
{card:label=HTTP Method}
POST
{card}
\\
{card:label=URL / Resource / Parameters}
*Resource*: authorize
*URL*: {nolink:https://api.bimplus.net/v2/}authorize
{card}\\ {card:label=Description}Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.
{card}\\ {card:label=Request}
\\
{code:title=Headers|borderColor=Green}
Content-Type: application/json
{code}
\\
{code:title=JSON|borderColor=Red}{
"user_id" : "test@bimplus.net",
"password" : "test"
}{code}
\\
{card}
\\
{card:label=Response|default=true}
\\
{code:title=Status|borderColor=Green}
Status: 200 OK
{code}
\\
{code:title=JSON|borderColor=Red}{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
}{code}
\\
{card}
\\
{deck}
{code}{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
|
...
}{code}
h3. 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} |
Example:
...
Deck of Cards |
---|
|
Card |
---|
label | Implementation Status |
---|
| Image Added 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
|
|
|
JSON Response:
Code Block |
---|
[4]
0: {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: |
| null"!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1: {
id: " |
| f404ee032e044d81873e13d672b02b7d null "__5 999 Parklife Salzburg Lehen"
}-
2: {
id: " |
| 1dc48a10f283497a83dee5f1b56c4a41null
}-
3: {
id: "586b02be-43b8-4e27-b698-e067e85e38e2"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"0811-Wohnhaus Kraus - Carport1"
} |
|
|
Get Project Properties
Deck of Cards |
---|
|
Card |
---|
label | Implementation Status |
---|
| Image Added Service available ! |
Card |
---|
label | URL / Resource / Parameters |
---|
| Resource: projects/<project_id> URL: https://api.bimplus.net/v2/<company>/projects/<project_id> Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff
|
Card |
---|
default | true |
---|
label | Description |
---|
| Get all the project properties of a project using its id. |
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 |
---|
| {
disciplines: [0]
name: null
shortDescr: null
thumbnail: null
created: "0001-01-01T00:00:00"
changed: "0001-01-01T00:00:00"
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
} |
|
|
Tools
Plugins for doing REST based calls (REST Client)
...