Subscriber API を使う

Subscriber API を用いると、ポケットサインアプリ外のサービスからもユーザーリソースを取得することができます。ここでは、ローカルで Subscriber API を用いたデモアプリを動かす方法を紹介します。

OIDC クライアントの設定をする

Subscriber API では、認証・認可の仕組みとして OpenID Connect (OIDC) を採用しています。 PocketSign Link では、OIDC に必要な仕組みを OIDC クライアントとして提供しています。デモアプリを動かすために必要な設定は以下の通りです。

OIDC クライアントを作成する

OIDC クライアントの作成を参照してください。クライアントシークレットが必要になるため、忘れずに保管してください。クライアントシークレットを紛失した場合は、再発行をしてください。なお、クライアントシークレットを再発行すると、以前のクライアントシークレットは無効になります。

リダイレクト URI の設定

デモアプリを動かすためには、OIDCクライアントのリダイレクト URI の設定が必要です。今回はローカルでデモアプリを起動するため http://localhost:8080/callback としてください。

リソースの設定をする

カスタムリソースの作成

リソース定義の作成を参照して、以下の定義のリソースを作成してください。

項目名	設定値
リソースSlug	`favorite-food`
リソース表示名	好きな食べ物
リソース説明	好きな食べ物です
JSON Schema	`{"type": "string"}`
リソースタイプ	読み書き可能

リソース要求の設定

デモアプリで使用するリソースへの Read 権限を付与します。権限を付与する必要のあるリソース定義は以下のものです。

氏名
生年月日
性別
住所
作成したカスタムリソース

リソース要求を参考に、これらのリソース定義に対してリソース要求を行います。基本4情報に関するリソース定義の ID はリソース定義一覧を参照してください。

デモアプリを起動する

必要環境の用意

このデモアプリでは、Go 1.22を使用します。 1.22よりも新しいバージョンを利用する場合は、オプションなどが異なる場合がありますので、適宜読み替えてください。

ダウンロード

Subscriber API を用いたデモアプリとして link-subscriber-api-example を公開しています。 git を使用する場合は以下のコマンドでダウンロードできます。

git clone https://github.com/pocketsign/link-subscriber-api-example

`.env` の設定

デモアプリのディレクトリに .env を設定する必要があります。以下はモック環境を用いる場合の設定例です。

OIDC_CLIENT_ID=<OIDC クライアントの ID>
OIDC_CLIENT_SECRET=<OIDC クライアントのクライアントシークレット>
OIDC_REDIRECT_URL=http://localhost:8080/callback
OIDC_DEMO_HOST=core.mock.p8n.app
CUSTOM_RESOURCE_ID=<作成したリソース定義の ID>
SESSION_SECRET=session-secret

起動

下記はデモアプリの起動コマンドです。

go run .

ブラウザ等で http://localhost:8080 にアクセスします。以下のような画面になることを確認してください。

デモアプリの初期画面

カスタムリソースの変更

カスタムリソースの値を変更してみます。以下のように、フォームに値を入力します。

デモアプリでカスタムリソースの値を入力する画面

変更ボタンをクリックすると、リクエストが発行されます。リクエストが正しく処理されると、以下のように、カスタムリソースの値が表示されます。

デモアプリでカスタムリソースの値が反映された画面

OIDC クライアントの設定をする​

OIDC クライアントを作成する​

リダイレクト URI の設定​

リソースの設定をする​

カスタムリソースの作成​

リソース要求の設定​

デモアプリを起動する​

必要環境の用意​

ダウンロード​

.env の設定​

起動​

ログイン​

カスタムリソースの変更​