Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
h2. Standard Procedure

Generally, the Bim\+ REST API calls consist of three steps for accessing the resources.

1. Send a request for the authentication token.

2. Receive the authentication token.

3. Use the token for making the API request for any resource.

h3. 1. Authentication token request

The authentication request for accessing the BimPlus resource should be sent in the JSON format using the [Authentication Service|bimplus:2.1.2 Authentication Service].

Example:

[http://bimplus-dev.mantro.net/v2/authorize]

{

 "user_id" : "test@bimplus.com",

 "password" : "test"

}

[http://bimplus-dev.mantro.net/v2/authorize]
{
 "user_id" : "coberender@nemetschektest@bimplus.com",
 "password" : "passwordtest"
}




h3. 2. Receive the authentication token


The token is received in the request.


h3. 3. Request the desired resource


h4.

h2. Tools

Plugins for doing REST based calls (REST Client)

Chrome \--> [Advanced REST client|https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo], [Postman - REST client|https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en], [Simple REST client|https://chrome.google.com/webstore/detail/simple-rest-client/fhjcajmcbmldlhcimfajhfbgofnpcjmb]

Firefox \--> [RESTClient|https://addons.mozilla.org/de/firefox/addon/restclient/]

For validating or formatting JSON \--> [http://jsonlint.com/|http://jsonlint.com/]