Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Sv translation
    languageen
    Info

    BellaDati Client API is a statefull HTTP based API available directly from the web browser. This API is dedicated for Javascript usage.

    Tip

    You can use the BellaDati Client API to extend BellaDati front-end functions or create various UI components. The most common use-cases are:

    • designing and implementing own menu structure and user controls inside report or dashboard
    • creating customised messaging and chatting functions
    • accessing detailed information about users, reports and dashboards

     

    Out-of-the-box Report Screen (without coding, no Client API used)Report Screen with custom menus etc (Client API used)

    How to start

    Activate Development console in your favourite web-browser using following steps.

    • Chrome Windows and Linux (Shift + Ctrl + J)
    • Chrome Mac OS (Option + Command + J)
    • Firefox Windows and Linux (Shift + Ctrl + K)
    • Firefox Mac OS (Option + Command + K)
    • Internet Explorer Windows (F12 or Fn + F12)
    • Safari Mac OS ( Enable Develop option by following steps - Command + comma, than click Advanced, than select Show Develop in menu bar,close window an use keys Option + Command + C) 

    Example - Getting signed user

    Log-in into BellaDati. Into the activated development console write following script:

    Code Block
    languagejs
    $.ajax({
      url: "https://service.belladati.com/user/api:signedUser",
      success: function(reply) { 
          console.log(reply.username)
      },
      xhrFields: {
          withCredentials: true
      }
    });

    As a result, the current user's username will be displayed in the console.

    How to get API call overview from BellaDati GUI

    The API call overview can be displayed directly in BellaDati GUI. This option is displayed only for users who have enabled the developer mode. Developer mode can be enabled in the user profile.

    After the developer mode is enabled, API call icon will be displayed for all related components:

    API call overview is displayed in:

    1. Report detail -> for each type of the view (chart, table, KPI label, geo map, custom content view)
    2. Search/Reports page -> for each report, user, dataset
    3. Data set detail ->  Data collecting forms -> for each form

    In import history, the ID of each import execution is displayed.

    Image Added

     

    Sv translation
    languageja
    Info

    BellaDati Client APIは、Webブラウザから直接利用可能なステートフルHTTPによりAPIです。このAPIは、Javascriptの使用に専用されています。

    Tip

    BellaDatiフロントエンド機能を拡張したり、様々なUIコンポーネントを作成するためにBellaDati Client APIを使用できます。最も一般的な使用場合は、次のとおりです。

    • レポートやダッシュボードの内部に独自のメニュー構造とユーザーコントロールの設計と実装
    • 機能をカスタマイズしたメッセージを作成し、チャット
    • ユーザー、レポートやダッシュボードの詳細情報にアクセス

     

    Out-of-the-boxレポート画面(コーディングなしで、使用されたクライアントAPIがない)カスタムメニューなどを使用したレポート画面(クライアントAPIを使用)

    起動方法

    次の手順を使用して、お気に入りのWebブラウザで開発コンソールをアクティブにする。

    • Chrome Windows và Linux (Shift + Ctrl + J)
    • Chrome Mac OS (オプション+ コマンド+ J)
    • Firefox Windows và Linux (Shift + Ctrl + K)
    • Firefox Mac OS (オプション+ コマンド+ K)
    • Internet Explorer Windows (F12 または Fn + F12)
    • Safari Mac OS ((以下の手順により、開発者向けオプションを有効にする - Command+カンマ、「Advanced」をクリック、メニューバーに「Show Develop」を選択し、オプション+コマンド+ Cキーを使用することでウィンドウを閉じる)

     

    例 - 署名したユーザを取得

    BellaDatiにログインします。起動された開発コンソールで以下のスクリプトを書き込みます:

    Code Block
    $.ajax({
      url: "https://service.belladati.com/user/api:signedUser",
      success: function(reply) { 
          console.log(reply.username)
      },
      xhrFields: {
          withCredentials: true
      }
    });

    結果は、現在ユーザーのユーザー名がコンソールに表示されます。

    How to get API call overview from BellaDati GUI

    The API call overview can be displayed directly in BellaDati GUI. This option is displayed only for users who have enabled the developer mode. Developer mode can be enabled in the user profile.

    After the developer mode is enabled, API call icon will be displayed for all related components:

    API call overview is displayed in:

    1. Report detail -> for each type of the view (chart, table, KPI label, geo map, custom content view)
    2. Search/Reports page -> for each report, user, dataset
    3. Data set detail ->  Data collecting forms -> for each form