Page History
The REST API allows other applications to directly access data provided by BellaDati and is the underlying interface for our mobile BI Business Intelligence BellaDati Piccolo. It's the most direct way to access the API. This reference document is designed for those interested in developing for platforms not supported by the SDKs or for those interested in exploring API features in detail.
...
Through the API, users can retrieve reports, charts and even entire dashboards to integrate with their own custom client application.
General Notes
Enable REST API
Before you can use access the REST API calls, you need to enable it in your application account:
domain configuration.
- Open your domain configuration page. To reach this page, move the mouse over your name in the upper right corner and click on the domain link.
- Under OAuth Settings, click Configure.
- Enter a Consumer Key and a Consumer Secret. You can ignore the other settings for now.
After specifying the consumerKey and consumerSecret, you will be able access the REST API interface.
Base URL
The base address to access the REST API is :
...
https://service.belladati.com/api/
...
SSL only
We require that all requests are done over SSL.
...
.
If you are using an on-premise deployment, it is https://your-server/belladati/api/.
SSL Only
All API requests to BellaDati cloud must be sent over SSL.
With an on-premise deployment, although not mandatory, we strongly recommend using SSL for security reasons
...
.
UTF-8
...
Encoding
Every string passed to and from the BellaDati REST API needs to be UTF-8 encoded. For maximum compatibility, normalize to Unicode Normalization Form C (NFC) before UTF-8 encoding.
Locale
...
BellDati REST API uses the locale parameter to specify language settings of content responses. If your app supports any you want to retrieve data in a language other than English, insert the appropriate IETF language tag. When a supported language is specified, BellaDati will return translated content or error fields (where applicable)where applicable.
Response Format
The BellaDati REST API uses the JSON format for any responses to API calls.
Error
...
Handling
Errors are returned using standard HTTP error code syntax. Any additional info is included in the body of the return call , in JSON -formattedformat. Error codes not listed here are described in the respective REST API methods listed belowmethod.
Standard API errors are:
Code | Description |
|---|---|
400 | Bad input parameter. Error message should indicate Refer to the error message to find out which one and why. |
401 | Bad or expired token. This can happen if the user or BellaDati revoked or expired an access token has expired or is otherwise invalid. To fix this, you should re-authenticate the user. |
403 | Bad OAuth request (wrong incorrect consumer key, bad nonce, expired timestamptime stamp...). Unfortunately, re-authenticating the user won't help hereRefer to the error message for details. |
404 | File or folder not found at the specified path. Check if the URL you're trying to access is correct. |
405 | Request method not expected (generally Unexpected request method. The request method should be GET or POST )depending on the request you're trying to make. |
503 | Your app is making too many requests and is being rate limited. 503s can trigger on a per-app or per-user basis. |
5xx | Server error. Refer to the error message for details. |
Next
...
Steps
| Children Display |
|---|
Overview
Content Tools