概要

Subscriber APIでは、OpenID Connect による認証・認可を用いて、 その認証したユーザーに代わって処理を実行できます。

Subscriber API は、Connect プロトコルに対応しています。 Connect プロトコルについては Verify APIも参照してください。

ミニアプリとの使い分け

ポケットサインアプリ外でサービスを動作させたい場合は Subscriber API を使用する必要があります。 一方で、以下のようにミニアプリを使用するメリットもあります。

• PocketSign アプリ内で全てが完結する
  • ユーザーに追加でアプリをインストールしてもらう必要がない
• Subscriber API では操作できないユーザーリソースがある
  • 呼び出し可能なリソース定義に該当するもの等

用途に応じてミニアプリを使用するか Subscriber API を利用するかを選択してください。

Subscriber API のフロー

以下のシーケンス図は、ユーザーリソースの取得・更新 API を外部サービスから利用する際のフローを示しています。

1. 認可エンドポイントに対して認証・認可リクエストを送ります。
2. 認可コードを受け取ります。
3. トークンエンドポイントに対して、トークンリクエストを送ります。
4. ID トークンとアクセストークンを受け取ります。
5. アクセストークンを用いて、Subscriber API を呼び出します。
6. レスポンスを受け取ります。