Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.
Schema
In general the input and output data format for all calls is JSON. We should follow a wide accepted naming convention like http://google-styleguide.googlecode.com/svn/trunk/jsoncstyleguide.xml#Property_Name_Guidelines
All communication will be using https. Http requests will be rejected.
The API calls follow the REST standard (http://en.wikipedia.org/wiki/Representational_State_Transfer).
This document uses the domain api.bimplus.net as domain name.
This specification shall be know as version 2 of the BimPlus Cloud Service API. The version will be coded in into the url as path named v2.
Authentication is performed by OIDC server (link: OpenID). Developer tools that can help to create a client: https://openid.net/certified-open-id-developer-tools/
HTTP Verbs
Following HTTP verbs are available and used for the described operations
HEAD
Can be issued against any resource to get just the HTTP header info.
GET
Used for retrieving resources – can either be a single object of a lift od objects.
POST
Used for creating resources, or performing custom actions.
PATCH
Used for updating resources with partial JSON data. Any kind of modifying operation on an existing resource will use PATH.
PUT
Used for replacing resources or collections. PUT can be used as an alternative to PATCH
DELETE
Used for deleting resources.
Rate Limiting
We limit requests to 60 per hour for unauthenticated requests. For requests using Basic Authentication or OAuth, we limit requests to 5,000 per hour. You can check the returned HTTP headers of any API request to see your current status:
X-RateLimit-Limit: 5000 X-RateLimit-Remaining: 4966
