概要
リソース の構成要素
リソース定義
「リソース定義」は、そのリソースの名前や説明等の情報を定義したものです。 図中の「リソース定義1」、「リソース定義2」、「リソース定義3」が該当します。 「券面事項入力補助APを用いて取得した住所」や「券面事項入力補助APを用いて取得した氏名」など、予め定義されているリソース定義もありますが、組織ごとに独自のリソース定義を作成することもできます。 リソース定義は、後述するユーザーリソースを持つかどうかで、二つに分類されます。
読み書き可能なリソース定義
ユーザーリソースを保有するリソース定義を指します。 図中の「リソース定義1」、「リソース定義2」が該当します。
呼び出し可能なリソース定義
ユーザーリソースを保有しないリソース定義を指します。 図中の「リソース定義3」が該当します。
読み込み専用のリソース定義
後述する「ポケットサインが提供するリソース定義」のうち一部は読み取り専用になります。
ユーザーリソース
ユーザーリソースとは、リソース定義に基づいたユーザーごとの値を指します。 図中の「ユーザーリソース1」、「ユーザーリソース2」が該当します。 例えば「券面事項入力補助APを用いて取得した住所」の場合、「券面事項入力補助APを用いて取得した各ユーザーの住所」がユーザーリソースに該当します。 一方、ユーザーリソースを持たないリソース定義も存在します。 例えば「プッシュ通知を送るための権限」はユーザーリソースを持ちません。 「券面事項入力補助APを用いて取得した住所」は読み書き可能なリソース定義に、「プッシュ通知を送るための権限」は呼び出し可能なリソース定義に該当します。 読み書き可能なリソース定義は、ユーザーリソースの構造を JSON Schema で定義します。 なお、実際にユーザーリソースを読み書きしたり、呼び出したりするためには、ユーザーの同意が必要なことに注意してください。
リソース要求可能なサービス
サービスは、全ての権限を自由に要求できるわけではありません。 各リソース定義に対して、「どのサービスが、どの権限を要求可能か」を設定できます。 例えば、「券面事項入力補助APを用いて取得した氏名」に関しては、全てのサービスが Read のみを要求できます。 予め用意されているリソース定義については、各サービスが要求可能な権限は固定されています。 一方、組織が定義したリソース定義については、要求可能な権限をその組織が独自に設定できます。
リソース要求
各サービスは、リソースを操作するために、リソース定義に対して権限を保持している必要があります。 例えば、プッシュ通知を送るためには、「プッシュ通知を送るための権限」が付与されている必要があります。 サービスがリソース定義に対して権限を要求することを、リソース要求と呼びます。 実際に要求する権限の内容は、リソース定義の種類によって異なります。
- 読み書き可能なリソース定義に対しては、Read と Write をそれぞれ要求できます。
- 呼び出し可能なリソース定義に対しては、Invoke を要求できます。
ポケットサインが提供するリソース
リソース定義は、開発者が独自に作成できるものの他に、ポケットサインが予め提供しているものがあります。 例えば、マイナンバーカードに記載された基本4情報の取得に関するものや、プッシュ通知の送信に関わるものがあります。 詳細はリソース定義一覧を参照してください。