Yellowﬁnを組み込む理由とその方法
開発者向け詳細情報

BIの組み込みにより収益を上げ、顧客ロイヤルティを高める
24時間365日、オンデマンドでソフトウェアに常駐する専任のデータアナリストのような体験をエンドユーザーに提供することを想像してみてください。これは、ライブデータを迅速に発見し、監視して、説明することで、情報に基づいた意思決定をリアルタイムに行うことができます。CEOから若手の経理担当者まで、誰もがビジネスを運営するための適切なデータへのアクセスを信頼できるようになりました。これらの機能は、ISVの顧客のロイヤリティを維持するのに役立つだけでなく、驚くほど低い投資とほぼゼロの研究開発費で提供することができます。

セルフサービスBI: ISVがROIを高め、顧客に力を与える方法

製品チーム向けYellowﬁn 組み込みアナリティクスウォークスルー

すべての組み込みシナリオ向けAPI

重要ヒント
Yellowﬁnの統合
まずはこちらから : 方法の選択についてご確認ください。

3つの包括的なオプションにより、開発者は最新のアプリケーションにYellowﬁn BIを素早く組み込むことができます。APIを使用することで、ウェブサイト、ウェブアプリケーション、デスクトップアプリケーションなど、複数のユースケースにまたがる作業が可能になります。今では誰もが真のインサイトを迅速に提供する文脈を意識したデータを提供できるようになりました。しかし、どの方法を使用すればよいのでしょうか。以下のボックスをクリックして詳細をご確認ください。

JavaScript API

Rest API

Soap API

APIは、コンテンツを組み込むための2つの幅広い方法をサポートしています。

Yellowﬁnは、サードパーティの開発者が独自のユーティリティ、アプリケーション、Yellowﬁn システムやコンテンツとの統合を作成できるようにするパブリックREST APIを公開しています。

SOAPサービスを使用することで、特定の管理機能へアクセスし、レポートコンテンツを取得することもできます。顧客は通常、新規クライアント組織やコンテンツのデプロイなど、一般的な管理タスクを自動化するために管理サービスを使用します。レポートサービスは、カスタムモバイルアプリケーションや、バッチレポートプロセスを作成できます。

●●

埋め込みリンク:
Yellowﬁn アプリケーション内から取得し、既存のアプリケーションにレポート、グラフ、ダッシュボードを組み込むために使用します。様々なパラメーターリンクを追加することで、組み込まれたコンテンツの見た目や動作を制御することができます。
高度なAPI:
高度なAPIを使用することで、組み込まれたコンテンツをより動的かつ柔軟に制御できます。

このAPIは、ストーリー、シグナル、ディスカッション、ストリーム、レポート (近日公開予定)、ユーザー、ユー
ザータイムラインなど、いくつかの主要なコンテンツタイプのほとんどの機能を公開しています。また、ユーザー管理、カテゴリー管理、インポート/エクスポート、システム構成、ユーザーセッション管理などの管理機能もあるため、開発者はYellowﬁn システムを管理・制御するための独自のユーティリティを提供することができます。

SOAPは、堅牢ではあるものの、最近人気が落ちているレガシーなプロトコルです。Yellowﬁnでは既存のSOAPサービスの維持やサポートを継続しますが、RESTful ウェブサービスはより最新のアプローチを提供します。

プロトタイピングを迅速に
Yellowﬁnはプロトタイピングを簡単にします。サンプルデータ、レポート、ダッシュボードのセットアップに時間を費やす必要はなく、スキーチームのサンプルデータセットを含む「オールインワン」のDocker イメージを使用できます。これにより、開発者は、製品のエキスパートになることなくAPIを使い始めることができます。
1)Docker イメージを取得して実行, 2)開発者ライセンスを追加, 3)APIを呼び出しライブデータを取得 この3つの簡単ステップで始められます。

1

docker run -p 9999:8080 yellowfinbi/yellowfin-all-in-one

2

開発者ライセンスを使用してYellowﬁn サーバを初期化します。

3

コードからAPIを呼び出します。

Yellowﬁnのホワイトラベル化
Yellowﬁnは、コーポレートカラー、フォント、ロゴ、リンクなどを組み込むことで、組織のブランドアイデンティティに合わせてスタイルを変更することができます。この統合により、YellowﬁnはOEMアプリケーションの中でシームレスに組織の拡張機能になり、ユーザーエクスペリエンスを向上させます。ブランディングは、クライアント組織ごとに管理することができ、各テナントが独自の外観を持つことができます。

スタイリングコンポーネント

ドキュメントおよび例

Yellowﬁn内でスタイルやカスタマイズが可能なコンポーネントは、以下のリンクをご参照ください。
●

システムログインページ●

システムヘッダー●

システムフッター

●

イメージ

●

CSS

●

レポート、グラフ、ダッシュボードのスタイリング

柔軟なアーキテクチャー
導入には複数の選択肢があります。Yellowﬁnをスタンドアローンのソリューションとして実行することも、既存のアプリケーションに組み込むこともできます。Yellowﬁnは、既存のアプリケーション外のデータソースからデータを取り込み、エクスペリエンスを向上させることもできます。そして、複数のアプリケーションに組み込むこともできます。

ユーザーインターフェースの選択
ローカル、リモート、ダッシュボードなど

ビジネスロジック & データアクセスレイヤー
豊富な機能を備えたビジネスインテリジェンスを使用して既存のシステムを迅速に強化

データレイヤー
既存のデータレイヤーを使用し、データ自動化により非構造化データを取り込むことで、既存のアプリケーション内でレポートすることができます。

APIを試してみましょう
作業を開始できるスクリプトロジックを公開
REST APIを使用したユーザー同期とシングルサインオン

REST / RPC APIへのアクセス

より詳細な情報はこちら

REST APIは /api ネームスペース配下で利用できます。例： https://yellowﬁn.myapp.com/api/stories
さらに製品には、REST パラダイムに適合するのが難しいワークフローをサポートするRPC (Remote Procedure Call: リモートプロシージャコール) エンドポイントが含まれています。
これらは、 /api/rpc ネームスペース配下に配置されています。
すべてのリクエストには認証ヘッダーが必要であり、その形式は以下の通りです。
1970年1月1日のユニックスエ
ポック 00:00:00 UTC からのミリ秒単位の時間YELLOWFIN ts=1600224140615 nonce=3370ddc4-37d9-41b9-9f24-ada181fdc4bf token=securityToken
Yellowﬁnでは、ホワイトラベル化の一部としてアプリケーションに名前を付けることができます。
これは、既存のアプリケーション名 (デフォルト
ではYellowﬁn) と一致しなくてはいけません。

クライアントにより生成されるランダムUUIDAPIにアクセスするためのセキュリティトークン。
基本的なルールとして、リフレッシュトークンを入力してアクセストークンを取得し、アクセストークンを使用してほとんどの APIを呼び出します。必要なトークンはAPIドキュメントに記載されています。

https://wiki.yellowﬁn.co.jp/display/yfcurrent/REST+API#RESTAPI-Authentication

Yellowﬁn API - セキュリティトークン
リフレッシュトークン

アクセストークン

ログイントークン

これは、API呼び出しの開始が許可されていることを確認するために使用されます。APIへの最初のレベルのアクセスを許可しますが、ユーザーセキュリティとは別のアプリケーションシークレットトークンだと考えてください。

リフレッシュトークンを使用することで、特定のユーザーとしてサインインし、アクセストークンを取得することができます。

アクセストークンを使用して、ダイレクトログイントークンをリクエストすることができます。

これでドアの鍵が手に入りましたが、まだ中に入ることはできません。そのためには、アクセストークンを取得する必要があります。

Yellowﬁn APIを呼び出したいです。こちらが詳細情報です。

かしこまりました。こちらが APIを呼び出すためのアプリケーションアクセスを許可するシークレットキーです。Yellowﬁn APIを起動する際には毎回こちらを使用してください。

アクセストークンを使用すると、プラットフォームのAPIを呼び出して、(例えば) ユーザーがお気に入りに登録したレポートの一覧を取得することができます。

こちらがリフレッシュトークンです。「 Steve」というユーザーを取得しました。 Yellowﬁn APIを呼び出す準備ができていることを識別するトークンをいただけますか。
こちらをどうぞ。こちらのトークンは 20分間有効です。こちらのトークンを使用して、「 Steve」というユーザーがアクセス権を付与された任意の APIを呼び出すことができます。

こちらがアクセストークンです。ダッシュボードの一覧をいただけますか。

こちらのアクセストークンは「 Steve」のものですね。
こちらがお気に入り登録されたレポートを含む一覧です。

これは、URLの一部としてYellowﬁnに直接ログインするリクエストの一部として使用することができます。これは1回のみの使用に限られるため、ログインするセッションごとにリクエストする必要があります。

こちらがアクセストークンです。シングルサインオンを有効にするトークンをいただけますか。これが URLに使用されることを承知しています。

あなたのアクセストークンは 「Steve」のものですね。こちらをどうぞ。この 1回限りのコードを使用してシステムにログインしてください。このコードをURLに入力するだけで、許可されたエントリーポイントに入ることができます。

シングルサインオンAPI

重要ヒント: SSOはYellowﬁnと迅速に統合し、素早く価値を提供する素晴らしい方法です。

シングルサインオンを使用するには、ユーザーおよびログイントークンが必要です。ログイントークンは5分間有効で、セッションを開始するために一度だけ使用できます (厳重なセキュリティ管理のため)。ログイントークンは、REST、RPC、SOAP APIのいずれかを使用して取得できます。ログイントークンは、URLの一部としてリダイレクトや、組み込みJavaScript APIウィジェットへのアクセスに使用できます。
ユーザーについてはパスワードが必要ですか？ Yellowﬁn経由で直接、またはAPIを介してユーザーを追加・更新・削除することができます。リフレッシュトークンを取得すると、APIはパスワードなしでアクセストークンを作成できるように構成され、統合を簡素化します。また、ユーザーがアプリケーション経由でのみYellowﬁnにアクセスできるようにする場合は、API経由でパスワードなしでユーザーを作成できます。パスワードを持たないユーザーはパスワードをリセットできないため、インテグレーターはアクセスを完全に制御することができます。
Yellowﬁnは、アクティブディレクトリのサポートを含む、SAML Bridge経由のシングルサインオンも提供しています。

APIを選択

ログイントークンの取得

ログイントークンを使用したシングルサインオン
トークンを使用して ログイン画面をパイパスします。

REST

RPC

(まだ取得していない場合は) リフレッシュトークンの取得

アクセストークンの取得

Webサービスの呼び出しで受け取ったトークンを使用して、ユーザーをURLに転送することができます。

ログイントークンの取得

http://<YELLOWFIN-SERVER>/logon.i4?LoginWebserviceId=<TOKEN>

ログイン
トークンの使用

ログイントークンの取得
dsionI

po

es
oginS
L.
esn

SOAP

LOGINUSER またはLOGINUSERNOPASSWORD

AdministResration

JavaScript API でのトークンの使用
SSOトークンは、JavaScript APIウィジェットを組み込んで使用することもできます。
トークンはスクリプトレットURLに以下のように追加されます。
<script type="text/javascript"
src="http://localhost/JsAPI?dashUUID=e9a6ab0a-bcb0-4fe6-9663-4dd
33e58f08e&token=<TOKEN>"></script>

開発者向けリソース
Yellowﬁn 選定ガイド

Yellowﬁn Wiki

Yellowﬁn YouTube

Yellowﬁn Community (US)

組み込みアナリティクス概要
既存のアプリケーションに組み込むことのできるYellowﬁnの優れた機能や特徴をご確認いただけます。
https://youtu.be/kHHNDCmdBBc

Yellowﬁn テクニカルウェビナー - Yellowﬁn REST API
はじめの一歩： https://yellowﬁn.co.jp/campaign/tcwebinar-ﬁrst-step-of-restapi-230227
実装編： https://yellowﬁn.co.jp/campaign/tcwebinar-rest-api-implement-230227

Yellowﬁn テクニカルウェビナー - YellowﬁnをDockerで動かす
https://yellowﬁn.co.jp/campaign/tcwebinar-docker-201223

Yellowﬁnは、自動化で強化されたワールドクラスの製品スイートを提供する、組み込みBIとアナリティクスソフトウェアのグローバルベンダーです。Yellowﬁnは、世界をリードするアナリスト企業から、イノベーターの評価を得ています。50の国々に渡り、29,000を超える組織で、300万人を超えるエンドユーザーが、日々Yellowﬁnを使用しています。より詳細な情報は、Yellowﬁn ウェブサイトをご確認ください。
開発用ライセンスのご依頼はYellowﬁn セールスチームまでお問い合わせください。