Page History
Sv translation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The REST API allows other applications to directly access data provided by BellaDati and is the underlying interface for our mobile Business Intelligence BellaDati Mobile. Through the API, users can retrieve reports, charts and even entire dashboards to integrate with their own custom client application.
General NotesEnable REST APIBefore you can access the REST API, you need to enable it in your domain configuration.
Base URLThe base address to access the REST API is If you are using an on-premise deployment, it is SSL OnlyAll API requests to BellaDati cloud service must be sent over SSL. With an on-premise deployment, although not mandatory, we strongly recommend using SSL for security reasons. UTF-8 EncodingEvery 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. LocaleBellDati REST API uses the locale parameter to specify language settings of content responses. If 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 where applicable. Response FormatThe BellaDati REST API uses the JSON format for any responses to API calls. And additionaly some responses can return HTML and PNG format for pictures.
Errors are returned using standard HTTP error code syntax. Any additional info is included in the body of the return call in JSON format. Error codes not listed here are described in the respective REST API method. Standard API HTTP errors are:
Application runtime errors are:
Next Steps
|
Sv translation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RESTAPIは、他のアプリケーションが直接にBellaDatiによって提供されたデータにアクセスすることを可能にし、モバイルビジネスインテリジェンスBellaDati Mobileの基礎となるインタフェースです。 APIを介して、ユーザーが独自のカスタム・クライアント・アプリケーションと統合するためレポート、チャート、全体のダッシュボードを取得できる。 一般的な注意事項Enable REST APIAPIにアクセスする前に、あなたのドメインの設定でそれを有効にする必要がある。
Base URLREST APIにアクセスするためのベースアドレスはhttps://service.belladati.com/api/です。 オンプレミス展開を使用している場合は、https://your-server/belladati/api/になる。 SSLのみBellaDatiクラウドサービスへのすべてのAPIリクエストは、SSL経由で送信する必要がある。 オンプレミス展開では、必須ではないが、強くセキュリティ上の理由のためにSSLを使用することをお勧める。 UTF-8エンコーディングBellaDati REST APIへのすべての文字列はUTF8でエンコードする必要がある。最大の互換性のために、UTF-8エンコーディングの前にUnicodeのUnicode C 正規化(NFC)に正規化する。 ロケールBellDatiRESTAPIは、コンテンツレスポンスの言語設定を指定するためロケールパラメータを使用している。あなたが英語以外の言語でデータを取得したい場合は、適切なIETF言語タグを挿入する。サポートされている言語が指定されている場合、BellaDatiは、コンテンツを翻訳返される。 レスポンス形式APIは、API呼び出しへのレスポンスのためのJSON形式を使用している。また、いくつかのレスポンスが映像のためにHTMLとPNG形式を返すことができる。
エラーは、標準HTTPエラーコードの構文を使用して返される。任意の追加情報は、JSON形式で復帰コールの本体に含まれている。ここに記載されていないエラー・コードは、それぞれのREST APIメソッドに記述されている。 標準API HTTPエラーは
アプリケーションのランタイムエラーは、次のとおりです。
次のステップ
|