RESTAPIは、他のアプリケーションが直接にBellaDatiによって提供されたデータにアクセスすることを可能にし、モバイルBusiness Intelligence BellaDati Mobileの基礎となるインタフェースです。 APIを介して、ユーザーが独自のカスタム・クライアント・アプリケーションと統合するためレポート、チャート、全体のダッシュボードを取得できます。

     

    一般的な備考

    REST APIを有効にします

    APIにアクセスする前に、あなたのドメインの設定でそれを有効にする必要があります

    1. ドメインの設定ページを開きます。このページに遷移するため、右上にある自分の名前の上にマウスを移動し、ドメインのリンクをクリックしてください。
    2. OAuth Settingsの下にConfigureをクリックします
    3. Consumer KeyConsumer Secretを入力します。今、他の設定を無視することができます。

    基本的なURL

    REST APIにアクセスするための基本的なアドレスはhttps://service.belladati.com/api/です。

    もしオンプレミス展開を使用している場合は、https://your-server/belladati/api/になります。

    SSLのみ

    BellaDatiクラウドサービスへのすべてのAPIリクエストは、SSL経由で送信する必要があります 

    オンプレミス展開では必須ではありませんが、セキュリティSSLを使用することを強くお勧めます

    UTF-8エンコーディング

    BellaDati REST APIへのすべての文字列はUTF8でエンコードする必要があります。最大の互換性のために、UTF-8エンコーディングの前にUnicodeUnicode C 正規化(NFC)に正規化します

    ロケール

    BellDati RESTAPIは、コンテンツレスポンスの言語設定を指定するためロケールパラメータを使用しています。あなたが英語以外の言語でデータを取得したい場合は、適切なIETF言語タグを挿入します。サポートされている言語が指定されている場合、BellaDatiはコンテンツを翻訳返されます

    レスポンスフォーマット

    BellaDati REST APIは、API呼び出しへのレスポンスにJSONフォーマットを使用しています。また、いくつかのレスポンスが映像のためにHTMLとPNG形式を返すことができます。

    Error Handling

    エラーは、標準HTTPエラーコードの構文を使用して返却される。任意の追加情報はJSONフォーマットで返却コールの本体に含まれます。ここに記載されていないエラー・コードは、それぞれのREST APIメソッドに記述されます。

    標準API HTTPエラーは

    コード

    説明

    400

    不正なインポートパラメータ。その理由を見つけるためにエラー・メッセージを参照してください。

    401

    不良または有効期限が切れたトークン。これは、アクセストークンの有効期限が切れているまたは無効でいる場合に発生する可能です。この問題を解決するには、ユーザーを再認証してください。

    403

    不良OAuthリクエスト(間違ったコンシューマキー、不良ナンス、期限切れのタイムスタンプなど)。詳細については、エラー・メッセージを参照してください。

    404

    ファイルまたはフォルダが指定されたパスに見つからない。あなたがアクセスしようとしているURLが正しいかどうかを確認してください。

    405

    予期しないリクエストメソッド。リクエストメソッドは作るしようとしているの要求に応じてGETするかPOSTになる。

    503

    アプリが多くの要求を作成すると速度が制限されます。 503sアプリまたはユーザーごとにトリガすることができます。

    5xx

    サーバーエラー。詳細については、エラー・メッセージを参照してください。

    アプリケーションのランタイムエラーは、次のとおりです。

    コード

    説明

    request_token_unauthorized

    合格したリクエストトークンが不正となって、使用できません。新しいリクエストトークンを作成します。

    request_token_rejected

    リクエストトークンが検証に不合格。間違ったフォーマットまたは破損しているかもしれません。。

    access_token_already_issued

    アクセストークンはすでに合格したリクエストトークンのために発行されました。

    invalid_consumer

    コンシューマキーが見つからないまたは要求に存在していませんでした。ドメインの設定とログファイルを確認してください。

    request_token_not_found

    アクセストークンのためにそれを交換するときにリクエストトークンが存在しないまたは見られません。

    token_not_found

    アクセストークンは存在していないまたは要求には見られない。これは、要求の整合性とコンシューマキーなどの他の前提条件が満たされていまるという意味です。

    token_unauthorized

    合格したアクセストークンは、不正とになって、使用できません。新しいリクエストトークンを作成します。

    parameter_absent
    必須パラメータは、リクエストには存在しません。
    user_not_found
    xAuth リクエスト(x_auth_username)で合格したユーザーパスが見つかりませんでした。
    too_many_login_failures
    xAuthを使用している時に組み合わせにユーザ/パスワード失敗になったログインが多すぎてあります。
    user_login_failed
    組み合わせユーザー/パスワードがxAuthを使用している時に有効になりません。。
    user_not_active
    xAuthを使用するときに、合格したユーザーがアクティブになりません。
    user_expired
    xAuthを使用するときに合格したユーザーアカウントがアクティブになりません。
    no_domain
    ユーザーがドメインに連結していません。
    domain_expired
    xAuthを使用している時にユーザーのドメインの有効期限が切れています。
    api_disabled
    REST APIはライセンスキーで有効になりません。

    次のステップ

    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 Notes

    Enable REST API

    Before you can access the REST API, you need to enable it in your domain configuration.

    1. 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.
    2. Under OAuth Settings, click Configure.
    3. Enter a Consumer Key and a Consumer Secret. You can ignore the other settings for now.

    Base URL

    The base address to access the REST API is https://service.belladati.com/api/.

    If you are using an on-premise deployment, it is https://your-server/belladati/api/.

    SSL Only

    All 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 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 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 Format

    The 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.

    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 format. Error codes not listed here are described in the respective REST API method.

    Standard API HTTP errors are:

    Code

    Description

    400

    Bad input parameter. Refer to the error message to find out which one and why.

    401

    Bad or expired token. This can happen if the access token has expired or is otherwise invalid. To fix this, re-authenticate the user.

    403

    Bad OAuth request (incorrect consumer key, bad nonce, expired time stamp...). Refer 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

    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.

    Application runtime errors are:

    Code

    Description

    request_token_unauthorized

    Passed request token has been unauthorized and cannot be used. Create new request token.

    request_token_rejected

    Request token didn't pass the validation. It may be in wrong format or corrupted.

    access_token_already_issued

    Access token was already issued for the passed request token.

    invalid_consumer

    Consumer key was not found or not present in the request. Check the domain settings and logs files.

    request_token_not_found

    Request token was not present or not found while trying to exchange it for access token.

    token_not_found

    Access token was not present or not found in the request. This may mean, that other prerequisites like request integrity and consumer key are fullfiled.

    token_unauthorized

    Passed access token has been unauthorized and cannot be used. Create new request token.

    parameter_absent
    Mandatory parameter is absent in the request.
    user_not_found
    User passed in xAuth request (x_auth_username) was not found.
    too_many_login_failures
    Too many login failures for user/password combination while using xAuth.
    user_login_failed
    User/password combination is not valid while using xAuth.
    user_not_active
    Passed user is not active while using xAuth.
    user_expired
    Passed user account is not active while using xAuth.
    no_domain
    User is not associated with a domain.
    domain_expired
    User domain validitiy expired while using xAuth.
    api_disabled
    REST API is not enabled in the license key.

    Next Steps

    • No labels