アプリ開発の流れ

本節ではアプリ開発の流れについて説明します。

まず、アプリ開発の流れの説明の前にいくつか知っておいた方がよいことを説明します。

OAuth 2.0 認可コードフロー

Personiumを使用したアプリの場合、アプリからのパーソナルデータへのアクセスはデータ主体Cell内のBoxに対してREST APIを通じて行います。この時、データアクセスの認可方法はOAuth 2.0の仕様に従います。OAuth 2.0のフローは種類がありますが、サンプルアプリではPDS事業者とアプリ事業者が異なる場合に採用する認可コードフローを使用します。

認可コードフローについての詳細は認可モデルを参照してください。

データ主体CellとアプリCell

認可コードフローで実装する場合、データ主体CellとアプリCellという2種類のCellを使用します。この2種類のCellは以下のように使われます。

Cell種類	説明
データ主体Cell	データ主体のデータ管理と認可
アプリCell	OAuth 2.0に従ったアプリの認可とアプリ資産の格納・公開

アプリCellは認可コードフローで以下のように使われます。

クライアント登録: アプリCell作成によって行う
client_id: アプリCellのURLを使用する
client_secret: アプリCell上のアカウントを使用してアプリの認証を行い、取得する

また、アプリCell上にHTML, JavaScript, CSSといったファイルを格納し、アクセス設定を誰でも参照できるようにすることで、静的Websiteのホスティングも行えます。本節のJavaScriptによるサンプルアプリはアプリCell上でホスティングすることを想定しています。

サンプルアプリでのデータ主体CellとアプリCellの関係を表すと次の図の通りとなります。

Cell Relation

アプリの開発はデータ主体Cell部分とアプリCell部分に対して行います。

Boxとbarファイルインストール

アプリはどのデータ主体Cellを使っても意図した挙動を行うために、Box上で同じデータ構造を取る必要があります。Personiumではアプリのユーザがアプリを使用する前に、データ主体Cellのデータ構造を定義するbarファイルを使ってBoxインストールを行い、アプリ固有のデータ構造をBox上に構築します。詳しくは以下ドキュメントを参照してください。

データ主体Cell部分の開発はBox上のデータ構造の構築とbarファイルの出力となります。

テンプレートアプリ

PersoniumコミュニティではReactベースのJavaScriptアプリのテンプレート及びデプロイメントツールを提供しています。

personium-blank-app

本ツールを使うことで、最小限のデータ主体CellとアプリCellからカスタマイズしてオリジナルのアプリを開発することができます。また、barファイルのビルドやアプリCellへのアップロードといった開発作業を簡単にします。

初期構築の流れ

テンプレートアプリの初期構築の流れは以下の通りとなります。

ローカル開発環境へのpersonium-blank-appのclone
アプリCellの構築
1. 設定ファイルの編集
2. アプリCellへのデプロイ (npm run deployの実行)
3. アプリCell上ファイルのACL設定
データ主体Cellの構築
1. barファイルのビルド (npm build-barの実行)
2. 開発用データ主体CellへのBoxインストール

具体的な手順はpersonium-blank-appを参照してください。

ACL設定やBoxインストールといったCell上の操作を行うのに前節で説明したUnit Managerが活用できます。