公開APIリスト
No

No

No

対象Block
サービス名

サービス名

1

1

1 operator

オペレーターサービス

2

1

2 operator

3

1

4
5

サービス概要オペレーター(運営メンバー、個人)のアカウン

名称

概要

URL

MethodIN

Region-

Root-

Root-

Block

Block

追加されたオペレーター

○

○

○

運営メンバー

更新されたオペレーター

○

○

○

運営メンバー
運営メンバー
運営メンバーOUTAPPBlock

追加

オペレーターを追加します。

.

POST

オペレーターサービス

更新

オペレーターを更新します。

/{operatorId}

PUT

3 operator

オペレーターサービス

削除

オペレーターを削除します。

/{operatorId}

DELETE

operatorId: オペレーターID

削除結果

○

○

○

1

4 operator

オペレーターサービス

種別による取得

種別（+ログインID）を指定してオペレーター情報を取得します。

.

GET

種別ログインID取得したオペレーター情報

○

○

○

1

5 operator

オペレーターサービス

IDによる取得

オペレーターIDを指定してオペレーター情報を取得します。

/{operatorId}

GET

operatorId: オペレーターID

取得したオペレーター情報

○

○

○

/login

POST

オペレーター認証情報

○

○

○

/ind/login

POST

オペレーター認証情報

○

○

○

ト管理と認証を行います。

追加するオペレーター

PxR-

operatorId: オペレーターID、更新する
オペレーター

認可条件

アプリケーション
運営メンバー
アプリケーション

個人以外のオペレーターでログインします。
61

6 operator

オペレーターサービス

ログイン

SMS認証を利用する場合、ワンタイムログインコードを生成しSMSでログイン者へ送付します。
それ以外の場合は、オペレーターをログインさせる。
個人オペレーターでログインします。

71

7 operator

オペレーターサービス

個人用ログイン

SMS認証を利用する場合、ワンタイムログインコードを生成しSMSで個人へ送付します。
それ以外の場合は、個人オペレーターをログインさせる。

ログイン情報 or ワンタイムログイン
コード送信結果

ログイン情報 or ワンタイムログイン
コード送信結果

運営メンバー
アプリケーション

個人
運営メンバー

81

8 operator

オペレーターサービス

透過ログイン

個人以外のオペレーターでIDコネクト連携を使用してログインします。

/login/sso

POST

アクセストークン

ログイン情報

○

○

○

9

1

9 operator

オペレーターサービス

ワンタイムログインコード照合

ワンタイムログインコードの照合に成功したら、オペレーターをログインさせます。

/login/onetime

POST

ワンタイムログインコード

ログイン情報○○○運営メンバー

101

10 operator

オペレーターサービス

個人用透過ログイン

個人オペレーターでIDコネクト連携を使用してログインします。

/ind/login/sso

POST

認証コード(IDコネクト)

ログイン情報

○

○

○

11

1

11 operator

オペレーターサービス

ログアウト

セッションIDを受け、ログイン中のオペレーターをログアウトさせます。

/logout

POST

セッションID

処理結果

○

○

○

個人
運営メンバー

121

12 operator

オペレーターサービス

個人用ログアウト

セッションIDを受け、ログイン中の個人オペレーターをログアウトさせます。

/ind/logout

POST

セッションID

処理結果

○

○

○

個人

13

1

13 operator

オペレーターサービス

セッション確認/session

POST

セッションID or アクセストークン

検証結果

○

○

○

全てのオペレーター

141

14 operator

オペレーターサービス

個人用セッション確認/ind/session

POST

セッションID or アクセストークン

検証結果

○

○

○

個人

15

1

15 operator

オペレーターサービス

パスワードリセット

オペレーターのパスワードをリセットします。

/password/{operatorId}

PUT

-

○

○

○

運営メンバー

161

16 operator

オペレーターサービス

個人用ワンタイムログインコード照合

ワンタイムログインコードの照合に成功したら、個人オペレーターをログインさせます。

/ind/login/onetime

POST

ワンタイムログインコード

ログイン情報

○

○

○

個人

17

1

17 operator

オペレーターサービス

本人性確認コード登録

本人性確認コードを登録する。

/ind/identifyCode

POST

本人性確認コード

処理結果

○

○

○

個人

18

1

18 operator

オペレーターサービス

利用者管理情報登録

個人オペレーターの利用者管理情報の登録・更新します。

/user/info

POST

利用者管理情報

PXR-ID○○○

運営メンバー

191

19 operator

オペレーターサービス

利用者管理情報削除

個人オペレーターの利用者管理情報の削除します。

/user/info

DELETE

query: pxrId, userId

PXR-IDリスト○○○

運営メンバー

20

1

20 operator

オペレーターサービス

個人による利用者管理情報修正

自身による個人オペレーターの利用者管理情報の登録・更新します。

/ind/user/info

PUT

利用者管理情報

処理結果

○

○

○

個人

21

1

21 operator

オペレーターサービス

利用者管理情報取得

指定したPXR-ID、利用者IDの利用者管理情報を取得します。

/user/info

GET

PXR-ID、利用者ID

利用者管理情報○○○運営メンバー

221

22 operator

オペレーターサービス

個人用利用者管理情報取得指定したPXR-ID、利用者IDの利用者管理情報を取得します。

/ind/user/info

GET

PXR-ID、利用者ID

利用者管理情報

○

○

○

個人

23

1

23 operator

オペレーターサービス

利用者管理情報リスト取得

指定したPXR-ID、利用者IDの利用者管理情報を複数取得します。

/user/info/list

POST

PXR-IDリスト

利用者管理情報○○○運営メンバー

241

24 operator

オペレーターサービス

利用者管理情報によるPXR-ID取得

検索条件に合致する利用者管理情報を持つ個人オペレーターのPXR-IDを取得します。

/user/info/search

POST

検索情報

PXR-IDリスト○○○

運営メンバー

25

1

25 operator

オペレーターサービス

SMS検証コード発行

電話番号を受け、SMS検証コードを発行しSMSで通知します。

/ind/sms-verificate

POST

電話番号

SMS検証コード

○

○

○

個人

26

1

26 operator

オペレーターサービス

SMS検証コード検証

検証コードIDコードおよびSMS検証コードを受け、検証結果を返却します。

/ind/sms-verificate/verifiy

POST

検証コードIDおよびSMS検証コード

検証結果

○

○

○

個人

27

2

1 catalog

カタログサービス

/name

PUT

更新されたカタログ情報○

流通制御SP運営メンバー

28

2

2 catalog

カタログサービス

カタログ名称取得

使用開始済のカタログの名称と説明、拡張ネームスペースを取得します。

/name

GET

なし

カタログ情報○運営メンバー、個人

29

2

3 catalog

カタログサービス

公開カタログ取得

公開が許可されているカタログ項目を取得します。

/public

GET

なし

カタログ項目

○

なし

30

2

4 catalog

カタログサービス

カタログ取得(code指定)

カタログ項目コードを指定して、最新バージョンのカタログ項目を取得します。

/{code}GET○

運営メンバー、個人

31

2

5 catalog

カタログサービス

カタログ取得(code,version指定)

カタログ項目コードとバージョンを指定して、カタログ項目を取得します。

/{code}/{ver}GET○

運営メンバー、個人

32

2

6 catalog

カタログサービス

カタログ取得(複数code指定)

複数のコードを指定して、カタログ項目を取得します。

/

POST

code: カタログ項目コード指定されたカタログ項目
code: カタログ項目コードver: カタログ指定されたカタログ項目
項目バージョン
code: カタログ項目コードver: カタログ指定されたカタログ項目
項目バージョン

○運営メンバー、個人

33

2

7 catalog

カタログサービス

ネームスペースによる取得

ネームスペースを指定して、カタログ項目を取得します。

/

GETns(QueryParam): ネームスペース

指定されたカタログ項目○

運営メンバー、個人

34

2

8 catalog

カタログサービス

内部クラス取得(code指定)/inner/{code}/{name}

GET

指定されたカタログ項目内部クラス○

運営メンバー、個人

35

2

9 catalog

カタログサービス

内部クラス取得(code,version指定)/inner/{code}/{ver}/{name}

GET

指定されたカタログ項目内部クラス○

運営メンバー、個人

36

2

10 catalog

カタログサービス

ネームスペース取得

ネームスペースIdを指定して、ネームスペースを取得します。

/ns/{nsId}

GET

nsId: ネームスペースId指定されたネームスペース○

運営メンバー、個人

37

2

11 catalog

カタログサービス

ネームスペースを指定してネームスペース取得

ネームスペースを指定して、前方一致のネームスペースを取得します。

/ns

GET

ns(QueryParam): ネームスペース

ネームスペース○

運営メンバー、個人

38

2

12 catalog

カタログサービス

拡張用ネームスペース追加

PXRインスタンス毎に作成される拡張用のネームスペース追加します。

/ns/ext

POST

追加されたネームスペース○

運営メンバー392

13 catalog

カタログサービス

拡張用ネームスペース更新

PXRインスタンス毎に作成された拡張用のネームスペース更新します。

/ns/ext/{nsId}

PUT

追加するネームスペース
nsId: 更新するネームスペースID更新す更新されたネームスペース○

運営メンバー402

14 catalog

カタログサービス

拡張用ネームスペース削除

PXRインスタンス毎に作成された拡張用のネームスペース削除します。

/ns/ext/{nsId}

DELETE

nsId: 削除するネームスペースID

削除結果

○

運営メンバー41

2

15 catalog

カタログサービス

拡張追加

PXRインスタンス毎に作成される拡張カタログ項目を追加します。

/ext

POST

追加するカタログ項目

追加されたカタログ項目○

運営メンバー422

16 catalog

カタログサービス

拡張更新

PXRインスタンス毎に作成された拡張カタログ項目を更新します。

/ext/{code}

PUT

更新されたカタログ項目○

運営メンバー43

2

17 catalog

カタログサービス

拡張削除

PXRインスタンス毎に作成された拡張カタログ項目を削除します。

/ext/{code}

DELETE

code: 削除するカタログ項目コード

削除結果

○

運営メンバー442

18 catalog

カタログサービス

変更セット情報取得

自身の変更セットリストを取得します。

/updateSet/search/info/{id}GET

id:変更セットID

対象変更セット情報○

運営メンバー452

19 catalog

カタログサービス

未承認変更セットリスト取得

自身の未承認変更セットリストを取得します。

/updateSet/search/request

GET

なし

未承認変更セット情報○

運営メンバー46

2

20 catalog

カタログサービス

承認済変更セットリスト取得

全ての承認済み変更セットリストを取得します。

/updateSet/search/approval

GET

なし

承認済変更セット情報○

運営メンバー47

2

21 catalog

カタログサービス

変更セット登録

変更セット(追加、更新、削除)を登録します。

/updateSet/register

POST

登録対象の変更セット情報

登録対象の変更セット情報○

運営メンバー48

2

22 catalog

カタログサービス

変更セット登録変更

変更セット(追加、更新、削除)を登録変更します。

/updateSet/register/{id}PUT

変更対象の変更セット情報

○

49

2

23 catalog

カタログサービス

変更セット登録削除

変更セット(追加、更新、削除)を削除します。

/updateSet/register/{id}DELETE

登録削除対象の変更セットID

登録削除対象の変更セットID

○

50

2

24 catalog

カタログサービス

変更セット申請

変更セット(追加、更新、削除)を申請します。

/updateSet/request

POST

申請対象の変更セットID、承認アクター

申請対象の変更セット情報

○

51

2

25 catalog

カタログサービス

変更セット承認

変更セット(追加、更新、削除)を承認・否認します。

/updateSet/approval/{id}POST

承認・否認対象の変更セット情報○

申請先アクターの運営メンバー/actor/accreditor

GET

認定アクター一覧○

運営メンバー

認定申請○

運営メンバー

登録された認定申請○

運営メンバー○

運営メンバー

My-Condition-Dataカタログの管理を行います。

カタログ名称更新

My-Condition-Dataカタログのうち、承認処理
52

3

1 catalog-update

カタログ更新サービス等追加で特殊な手順を踏むカタログの管理を行

申請先取得

います。

セッションIDまたはIDコネクトサービスのアクセストークンを受け、有効か確認します。
有効な場合、オペレーター情報を返します。
セッションIDまたはIDコネクトサービスのアクセストークンを受け、有効か確認します。
有効な場合、オペレーター情報を返します。

カタログ名と説明、拡張ネームスペースを指定して、使用開始済のカタログの名称、説明、
拡張ネームスペースを更新します。

カタログ項目コードと内部クラス名を指定して、最新バージョンのカタログ項目内部クラスを取得します。
カタログ項目コードとバージョン、内部クラス名を指定して、カタログ項目内部クラスを取得します。

申請するアクター種別を受け、その種別の認定を行っているアクター一覧を返却します。申請前はクライアント証明書がないため、申請するアクターの検証は行いません。

operatorId:オペレーターID、新パスワー
ド

カタログ名、カタログ説明、拡張ネーム
スペース

code: カタログ項目コードname: 内部ク
ラス名
code: カタログ項目コードver: カタログ
項目バージョンname: 内部クラス名るネームスペース

code: 更新するカタログ項目コード更新
するカタログ項目

変更対象の変更セットID、変更対象の変
更セット情報承認・否認対象の変更セットID、ステー
タス、コメント
actorType(query): 申請アクター種別

アプリケーション

アプリケーション

変更セットを登録したアクターの運営メンバー
変更セットを登録したアクターの運営メンバー
変更セットを登録したアクターの運営メンバーcode(query): 申請元Blockカタログコー
ドver(query): 申請元Blockカタログバー
53

3

2 catalog-update

カタログ更新サービス

アクター認定申請取得

認定申請を取得します。

/actorGET

ジョン
actorType(query): 申請アクター種別
approved(query): 承認済みを含むかど
うか

54

3

3 catalog-update

カタログ更新サービス

アクター認定申請

55

3

4 catalog-update

カタログ更新サービス

アクター認定解除申請

56

3

5 catalog-update

カタログ更新サービス

Region参加申請取得

拡張カタログ項目(アクター)を受け、認定を行うアクターへ承認を要求します。申請前はク/actor

POST

認定申請

拡張カタログ項目(アクター)を受け、認定解除を行うアクターへ承認を要求します。

/actor/remove

POST

認定解除申請登録された認定解除申請
is_request(query): 自分が申請したもの

Region参加申請を取得します。

/join

GET

か

ライアント証明書がないため、申請するアクターの検証は行いません。

参加申請

○

in_approved(query): 承認済みを含むか

運営メンバー(流通制御SPF, APP,
領域運営SP)
運営メンバー(流通制御SPF, APP,

57

3

6 catalog-update

カタログ更新サービス

参加要求

APP-Block、またはAPPがRegionへ参加するための要求を登録します。

/join

POST

参加要求

登録された参加要求

○

58

3

7 catalog-update

カタログ更新サービス

離脱要求

APP-Block、またはAPPがRegionから離脱するための要求を登録します。

/join/remove

POST

離脱要求

登録された離脱要求

○

59

3

8 catalog-update

カタログ更新サービス

（欠番）

60

3

9 catalog-update

カタログ更新サービス

（欠番）

61

3

10 catalog-update

カタログ更新サービス

（欠番）

62

3

11 catalog-update

カタログ更新サービス

Region作成/削除管理取得

Region作成/削除管理を取得します。

/regionGET

Region作成/削除管理

○

63

3

12 catalog-update

カタログ更新サービス

Region作成

Regionを作成します。

/region

POST

作成管理

登録された作成管理○

運営メンバー(領域運営SP)

64

3

13 catalog-update

カタログ更新サービス

Region削除

Regionを削除します。

/region/delete

POST

削除管理

登録された削除管理○

運営メンバー(領域運営SP)

1 / 3 ページ

in_approved(query): 承認済みを含むかどうか

領域運営SP)
運営メンバー(流通制御SPF, APP,
領域運営SP)

運営メンバー(流通制御SP, 領域
運営SP)

公開APIリスト
No

No

No

対象Block
サービス名

サービス名

サービス概要

名称

概要

URL

Method

IN

OUT

PxR-

Region-

Root-

Root-

Block

Block

APPBlock

認可条件
運営メンバー(流通制御SP, 領域

65

3

14 catalog-update

カタログ更新サービス

Region開始終了申請取得

Region開始終了申請を取得します。

/region/status

GET

in_approved(query): 承認済みを含むか 開始終了申請

○

66

3

15 catalog-update

カタログ更新サービス

Region開始要求

Regionを開始するための要求を登録します。

/region/status/start

POST

開始申請

登録された開始申請

○

67

3

16 catalog-update

カタログ更新サービス

Region終了要求

Regionを終了するための要求を登録します。

/region/status/end

POST

終了申請

登録された終了申請

○

68

3

17 catalog-update

カタログ更新サービス

PF利用規約作成

利用規約情報を受け、利用規約を作成します。

/platform-terms-of-use

POST

PF利用規約登録されたPF利用規約○

運営メンバー(流通制御SP)

69

318 catalog-update

カタログ更新サービス

PF利用規約更新/platform-terms-of-use

PUT

PF利用規約更新されたPF利用規約○

運営メンバー(流通制御SP)

70

319 catalog-update

カタログ更新サービス

Region利用規約作成

POST

Region利用規約登録されたRegion利用規約○

運営メンバー(領域運営SP)

71

3

20 catalog-update

カタログ更新サービス

Region利用規約更新

利用規約情報を受け、利用規約を作成します。
/region-terms-of-use
利用規約情報を受け、利用規約を更新します。再同意が必要な場合、個人へ同意を要求しま/region-terms-of-use
す。

PUT

Region利用規約更新されたRegion利用規約○

運営メンバー(領域運営SP)

72

3

21 catalog-update

カタログ更新サービス

蓄積イベント通知定義作成

蓄積イベント通知定義テーブルを作成します。

/store-event

POST

蓄積イベント通知定義

処理結果

○

運営メンバー(APP)73

3

22 catalog-update

カタログ更新サービス

蓄積イベント通知定義更新

蓄積イベント通知定義テーブルを更新します。

/store-event

PUT

蓄積イベント通知定義

処理結果

○

運営メンバー(APP)74

3

23 catalog-update

カタログ更新サービス

（欠番）

75

3

24 catalog-update

カタログ更新サービス

（欠番）

76

3

25 catalog-update

カタログ更新サービス

変更セット申請

変更セット申請を行い、承認アクターに承認要求を通知します。

/updateSet/request

POST

変更セット申請○

運営メンバー773

26 catalog-update

カタログ更新サービス

変更セット承認

変更セット申請の承認を行い、申請者に承認結果を通知します。

/updateSet/approval/:id

POST承認された変更セット申請○

運営メンバー

プロキシー

対象のBlockにある本サービスへ透過アクセスするAPI.

個人用プロキシー

プロキシーAPIの個人用

/ind

登録

通知を登録する。必要があれば他Blockへの連携などを行う

利用規約情報を受け、利用規約を更新します。再同意が必要な場合、個人へ同意を要求します。

変更セット申請ID
承認アクターコード
承認結果

運営SP)
運営メンバー(流通制御SP, 領域
運営SP)
運営メンバー(流通制御SP, 領域
運営SP)

PXR-Blockのサービスへ各種メソッドでProxyを
行う。
78

4

1 pxr-block-proxy

PXR-Block-Proxyサービス

なお、認可における静的評価は本サービスの責務であるが、動的認可はAPIトークン発行を担う

GET/POST/DEL リクエストのパラメータ、ヘッダ

レスポンスのステータスコード、ヘッ

ETE/PUT

ダ、ボディ(Credentialを除く)、ボディ

○

○

○

個人以外

○

○

○

個人

アクセス制御・アクセス制御管理サービスの責務となっている。
GET/POST/DEL リクエストのパラメータ、ヘッダ

レスポンスのステータスコード、ヘッ

ETE/PUT(Credentialを除く)、ボディ

ダ、ボディ

.

POST

通知

登録された通知○○○すべてのオペレーター

登録されている通知を、そのリクエストの条件を元に取得する

.

GET

検索条件

通知

○

○

○

すべてのオペレーター

既読登録された通知に対し、既読フラグをつける

.

PUT

通知ID
通知ID

処理結果

○

○

○

すべてのオペレーター

承認登録された承認要求タイプの通知に対し、否認や承認を行う/approval

PUT

コメント

承認結果

○

○

○

POST

ステータス
検索情報

共有アクセスログ

○

個人

79

4

2 pxr-block-proxy

PXR-Block-Proxyサービス

80

5

1 notification

通知サービス81

5

2 notification

通知サービス

取得

82

5

3 notification

通知サービス83

5

4 notification

通知サービス

84

6

1 book-manage

My-Condition-Book管理サービス

85

62 book-manage

My-Condition-Book管理サービス

オペレーターへ通知や承認要求を行います。

My-Condition-Bookの管理を行います。

運営メンバー
アプリケーション

共有アクセス取得依頼

ログインしている個人の共有アクセスログを取得します。
/accesslog
本人性確認事項を受け、individualとPXRログインコードを作成し、PXRログインコードをBook開設返却します。本人性確認事項でMy-Condition-Bookの存在が確認できないこと。IDコネク

.

POST

本人性確認事項

PXRログインコード○

運営メンバー(Root)/check/pxr-id

POST

pxrId: 重複チェックを行うpxrId

判定結果

○

運営メンバー(Root)

本人性確認書類

判定結果○

運営メンバー(Root)

削除結果

○

運営メンバー(Root)
個人

86

6

3 book-manage

My-Condition-Book管理サービス

PXR-ID重複チェック

トサービスを使用する場合、属性更新を呼び出す。
すでに存在するPXR-IDがないかチェックして結果を返却します。

87

6

4 book-manage

My-Condition-Book管理サービス

本人性確認書類重複チェック

本人性確認書類を受け、既に存在する本人性確認書類かチェックして結果を返却します。

/check/identification

POST

88

6

5 book-manage

My-Condition-Book管理サービス

強制削除

流通制御により、My-Condition-Bookを強制的に削除します。

/force/{PXR-ID}

DELETE89

66 book-manage

My-Condition-Book管理サービス

Book閉鎖My-Condition-Bookを閉鎖し、オペレータを削除する。

.

DELETE-

My-Condition-Data出力コード

○

90

6

7 book-manage

My-Condition-Book管理サービス

（欠番）

91

6

8 book-manage

My-Condition-Book管理サービス

データ出力準備

My-Condition-Data出力コードを登録します。

/output/condition/prepare

POST

出力データ

y-Condition-Data出力コード

○

92

6

9 book-manage

My-Condition-Book管理サービス

My-Condition-Book一覧取得

My-Condition-Bookの一覧を取得します。

/search

POST

検索情報

My-Condition-Book属性○

運営メンバー(Root)

93

6

10 book-manage

My-Condition-Book管理サービス

本人性確認事項取得

個人が本人性確認事項を取得します。

/identification

GET-

本人性確認事項

○

個人

94

6

11 book-manage

My-Condition-Book管理サービス

本人性確認事項検索

本人性確認事項を取得します。

/identity

POST

PXR-ID

本人性確認事項○

運営メンバー(Root)95

6

12 book-manage

My-Condition-Book管理サービス

パスワード再作成/login-code

POST

id: PXR-ID

PXRログインコード○

運営メンバー(Root)

96

6

13 book-manage

My-Condition-Book管理サービス

CToken件数取得

個人が蓄積したデータ種と量を取得する。

/ctoken

POST

検索対象時間CToken

○

個人

97

6

14 book-manage

My-Condition-Book管理サービス

BOOK参照依頼

PXR-IDを受け、個人に紐づくBOOKを取得する。

/book/search

POST

検索情報

BOOK

○

個人
個人

98

6

15 book-manage

My-Condition-Book管理サービス

利用者ID連携/cooperate

POST

本人性確認コード

連携結果○

アプリケーション

PXR-IDを受け、PXRログインコードの再度作成します。再作成条件は、Book開設権限のあるオペレーターからの申請で対象のオペレーターの電話番号が設定されていること。

本人性確認コード照合を呼出し、PXR-IDと利用者IDを連携する。利用者ID連携条件は、本
人性確認が成功していること。

pxrId: PXR-ID query: physicalDelete（物理削除フラグ）個人
運営メンバー99

6

18 book-manage

My-Condition-Book管理サービス

利用者ID連携取得

ログイン情報のPXR-IDをもとに、その個人が連携している情報を返却する。

/cooperate

GET

-

連携情報

○

運営メンバー(Root)
個人

100

6

19 book-manage

My-Condition-Book管理サービス

データ蓄積定義追加

データ蓄積定義をindividualに追加します。

/settings/store

POST

データ蓄積定義追加されたデータ蓄積定義

○

個人

101

6

20 book-manage

My-Condition-Book管理サービス

データ蓄積定義削除

individualからデータ蓄積定義を削除します。

/settings/store/{storeId}

DELETE

storeId: データ蓄積定義ID

削除結果

○

個人

102

6

21 book-manage

My-Condition-Book管理サービス

データ蓄積定義取得

individualからデータ蓄積定義を取得します。

/settings/store/{id}GET

id: PXR-IDまたは利用者ID

データ蓄積定義

○

個人

103

6

22 book-manage

My-Condition-Book管理サービス

一時的データ共有コード生成

一時的データ共有定義をindividualに追加し、一時的データ共有コードを生成します。

/share/temp

POST

一時的データ共有定義

一時的データ共有コード

○

個人

104

6

23 book-manage

My-Condition-Book管理サービス

一時的データ共有コード照合

一時的データ共有コードを受け照合します。

/share/temp/collation

POST

一時的データ共有コード

一時的データ共有定義○

運営メンバー(APP)105

6

24 book-manage

My-Condition-Book管理サービス

一時的データ共有コード取得

一時的データ共有コードを取得します。

/share/temp

GET

一時的データ共有定義一覧

○

個人

106

6

25 book-manage

My-Condition-Book管理サービス

利用者情報登録PXR-IDが一致する利用者情報を更新します。

/user/info

POST

PXR-ID、利用者情報

処理結果

○

運営メンバー(Root)

107

6

26 book-manage

My-Condition-Book管理サービス

ガイダンス送信

初回ログイン用のSMSを送信します。

/sms/open

POST-

PxR-ID, 初回パスワード○

運営メンバー(Root)108

627 book-manage

My-Condition-Book管理サービス

Book取得個人のBookを取得します。

GET-

Book情報

○

個人

109

6

28 book-manage

My-Condition-Book管理サービス

appendix更新（個人）Bookの付録を更新します。

/appendix

PUT-

Book情報

○

個人

110

6

29 book-manage

My-Condition-Book管理サービス

（欠番）

111

6

30 book-manage

My-Condition-Book管理サービス

未同意規約取得（個人）

個人が未同意の規約を取得します。

/term_of_use/request/list

GET

取得条件

未同意規約情報

○

個人

112

6

31 book-manage

My-Condition-Book管理サービス

PF利用規約同意

個人が未同意のPF利用規約に同意します。

/term_of_use/platform

POST

同意規約カタログコード

処理結果

○

個人

113

6

32 book-manage

My-Condition-Book管理サービス

Region利用規約同意

個人が未同意のRegion利用規約に同意します。

/term_of_use/region

POST

同意規約カタログコード

処理結果

○

個人

114

6

33 book-manage

My-Condition-Book管理サービス

（欠番）

115

6

34 book-manage

My-Condition-Book管理サービス

My-Condition-Data出力コード取得

My-Condition-Data出力コードのレコードを取得します。

/output

POST

query: expiration(有効期限切れを含むかどうか)

検索情報 query: offset(スキップ行数)、
limit(取得件数)

個人
My-Condition-Data出力コード○

アプリケーション
運営メンバー(APP)

query: offset(スキップ行数)、limit(取得件数)、id: 出力データ収集アクターid、
116

635 book-manage

My-Condition-Book管理サービス

出力データ収集アクター取得

出力データ収集アクターのレコードを取得します/output/condition

GET

mcdOutputCodeId: My-Condition-Data
出力ID、approved: 承認ステータス、

出力データ収集アクター○

運営メンバー(Root, APP)

出力データ管理○運営メンバー(Root)

isServiceCanceled: Region利用者連携解除ステータス
query: offset(スキップ行数)、limit(取得117

6

36 book-manage

My-Condition-Book管理サービス

出力データ管理取得

出力データ管理のレコードを取得します。

/output/condition/data_mng/search

POST

118

6

37 book-manage

My-Condition-Book管理サービス

出力データ管理更新

出力データ管理の更新を行います。

/output/condition/data_mng/{id}PUT

id: 出力データ管理id、出力データ管理

出力データ管理○運営メンバー(APP)119

6

38 book-manage

My-Condition-Book管理サービス

データ共有定義追加

データ共有定義をindividualに追加します。

/setting/share

POST

データ共有定義追加されたデータ共有定義

○

個人

120

6

39 book-manage

My-Condition-Book管理サービス

データ共有定義削除

individualからデータ共有定義を削除します。

/setting/share/{shareId}

DELETE

shareId: 継続的データ共有定義ID
query: id(利用者ID)、app(アプリケー

削除結果

○

個人

121

6

40 book-manage

My-Condition-Book管理サービス

データ共有定義取得

データ共有定義を取得します。

/setting/share

GET

継続的データ共有定義○

すべてのオペレーター

件数)、approved: 承認ステータス

ションカタログコード(_valueのみ))、
actor(アクターカタログコード(_valueの
み))

122

6

41 book-manage

My-Condition-Book管理サービス

（欠番）

123

6

42 book-manage

My-Condition-Book管理サービス

（欠番）

124

6

43 book-manage

My-Condition-Book管理サービス

（欠番）

125

6

44 book-manage

My-Condition-Book管理サービス

（欠番）

126

6

45 book-manage

My-Condition-Book管理サービス

Book無効化127

6

46 book-manage

My-Condition-Book管理サービス

強制解除

128

6

47 book-manage

My-Condition-Book管理サービス

ユーザー取得129

7

1 book-operate

My-Condition-Book運用サービス

130

7

2 book-operate

My-Condition-Book運用サービス

My-Condition-Bookへデータの蓄積と共有を行います。

PXR-IDをリクエストに、関連付けられたBookの無効化およびその個人のログインを禁止さ/force-deletion

PUT

pxrId: 対象BookのPXR-ID

処理結果

○

運営メンバー(Root)/force-enable

PUT

pxrId: 対象BookのPXR-ID

処理結果

○

運営メンバー(Root)

ユーザーIDからユーザー情報を取得します。

/search/user

POST

検索情報

My-Condition-Book属性○

運営メンバー

利用者作成

利用者情報を受け、利用者を作成します。

/user

POST

利用者情報

作成された利用者○○

運営メンバー(APP, 領域運営SP)

利用者削除

本人性確認コードを受け、利用者を削除します。

/user/delete

POST

本人性確認コード削除された利用者のID○○

運営メンバー(APP, 領域運営SP)

せます。
PXR-IDをリクエストに、関連付けられたBookの無効化およびログインの禁止を解除します。

2 / 3 ページ

公開APIリスト
No

No

No

対象Block
サービス名

サービス名

サービス概要

名称

概要

URL

Method131

7

3 book-operate

My-Condition-Book運用サービス

利用者一覧検索

検索条件を受け、利用者一覧を取得します。

/user/list

POST

132

7

4 book-operate

My-Condition-Book運用サービス

イベント蓄積イベント配列を受け、Bookへ登録します。

/event/{userId}

POST

133

7

5 book-operate

My-Condition-Book運用サービス

ソースIDによるイベント更新

ソースID、利用者ID、イベントを受け、Bookのイベントを更新します。

/event/{userId}

PUT

IN

検索条件

OUT

PxR-

Region-

Root-

Root-

Block

Block

APPBlock

認可条件
アプリケーション

利用者一覧

○

○

登録されたイベント○○

アプリケーション

更新されたイベント○○

アプリケーション

更新されたイベント○○

アプリケーション

eventSourceId(query): イベントのソー 削除されたイベント○○

アプリケーション削除されたイベント○○

アプリケーション追加されたモノ○○アプリケーション追加された複数モノ○○

アプリケーション

更新されたモノ○○アプリケーション

更新されたモノ○○アプリケーション削除されたモノ○○アプリケーション削除されたモノ○○アプリケーション登録されたドキュメント○○

アプリケーション

更新されたドキュメント○○

アプリケーション

更新されたドキュメント○○

アプリケーション

documentSourceId(query): ドキュメン 削除されたドキュメント○○

アプリケーション削除されたドキュメント○○

アプリケーション

対象データ

○

○

アプリケーション

統合された共有データ○○

アプリケーション

userId: 利用者ID
イベント配列userId: 利用者ID
eventSourceId(query): イベントのソースID

運営メンバー(APP, 領域運営SP)

イベント
userId: 利用者ID
134

7

6 book-operate

My-Condition-Book運用サービス

イベント更新利用者ID、イベント識別子、イベントを受け、Bookのイベントを更新します。

/event/{userId}/{eventId}

PUT

eventId: イベント識別子
イベント
userId: 利用者ID

135

7

7 book-operate

My-Condition-Book運用サービス

ソースIDによるイベント削除

利用者ID、ソースIDを受け、Bookのイベントを削除します。

/event/{userId}

DELETE136

78 book-operate

My-Condition-Book運用サービス

イベント削除利用者ID、イベント識別子を受け、Bookのイベントを削除します。

/event/{userId}/{eventId}

DELETE137

79 book-operate

My-Condition-Book運用サービス

モノ追加

利用者ID、イベント識別子、モノを受け、Bookのイベントにモノを追加します。

/thing/{userId}/{eventId}

POST

スID
userId: 利用者ID
eventId: イベント識別子
userId: 利用者ID
userId: 利用者ID
eventId: イベント識別子
モノ
userId: 利用者ID

138

7

10 book-operate

My-Condition-Book運用サービス

モノ一括追加

利用者ID、イベント識別子、モノ配列を受け、Bookのイベントに複数モノを追加します。 /thing/bulk/{userId}/{eventId}

POST

eventId: イベント識別子
モノ配列
userId: 利用者ID

139

7

11 book-operate

My-Condition-Book運用サービス

ソースIDによるモノ更新

利用者ID、イベント識別子、モノのソースID、モノを受け、Bookのモノを更新します。

/thing/{userId}/{eventId}

PUT

eventId: イベント識別子
thingSourceId(query): モノのソースID
モノ
userId: 利用者ID

140

7

12 book-operate

My-Condition-Book運用サービス

モノ更新

利用者ID、イベント識別子、モノ識別子、モノを受け、Bookのモノを更新します。

/thing/{userId}/{eventId}/{thingId}

PUT

eventId: イベント識別子
thingId: モノ識別子
モノuserId: 利用者ID

141

7

13 book-operate

My-Condition-Book運用サービス

ソースIDによるモノ削除

利用者ID、イベント識別子、モノのソースIDを受け、Bookのモノを削除します。

/thing/{userId}/{eventId}

DELETE

eventId: イベント識別子
thingSourceId(query): モノのソースID
userId: 利用者ID

142

7

14 book-operate

My-Condition-Book運用サービス

モノ削除

利用者ID、イベント識別子、モノ識別子を受け、Bookのモノを削除します。

/thing/{userId}/{eventId}/{thingId}

DELETE143

715 book-operate

My-Condition-Book運用サービス

ドキュメント蓄積

利用者ID、ドキュメントを受け、Bookへ登録します。

/document/{userId}

POST

144

7

16 book-operate

My-Condition-Book運用サービス

ソースIDによるドキュメント更新

ソースID、利用者ID、ドキュメントを受け、Bookのドキュメントを更新します。

/document/{userId}

PUT

145

146

7

7

17 book-operate

18 book-operate

My-Condition-Book運用サービス

ドキュメント更新

My-Condition-Book運用サービス

ソースIDによるドキュメント削除

利用者ID、ドキュメント識別子、ドキュメントを受け、Bookのドキュメントを更新します。

eventId: イベント識別子
thingId: モノ識別子
userId: 利用者ID
ドキュメントuserId: 利用者ID
documentSourceId(query): ドキュメン
トのソースID
ドキュメントuserId: 利用者ID/document/{userId}/{documentId}

PUT

documentId: ドキュメント識別子
ドキュメントuserId: 利用者ID

利用者ID、ソースIDを受け、Bookのドキュメントを削除します。

/document/{userId}

DELETE147

7

19 book-operate

My-Condition-Book運用サービス

ドキュメント削除

利用者ID、ドキュメント識別子を受け、Bookのドキュメントを削除します。

/document/{userId}/{documentId}

DELETE148

7

20 book-operate

My-Condition-Book運用サービス

データ共有によるデータ取得

データ共有を呼び出し、データを取得します。

/share

POST

149

7

21 book-operate

My-Condition-Book運用サービス

一時的データ共有によるデータ取得

一時的データ共有コードを受け、データを取得後、統合処理を行って返却します。

/share/temp

POST

本人性確認事項取得

本人性確認事項を取得します。

トソースID
userId: 利用者ID
documentId: ドキュメント識別子
データ取得条件
tempShareCode: 一時的データ共有コード

カタログにより、本人性確認における処理を一
160

8

1 identity-verificate

本人性確認サービス

括して行う。
第三者, 本人による照合、確認書類の登録、それ/acquisition/identification/{identifyCode}

GET

identifyCode: 本人性確認コード

本人性確認事項○

本人性確認コード○

運営メンバーを基に特定などのAPIを提供する。
161

8

2 identity-verificate

本人性確認サービス

コード発行

本人性確認を行うための本人性確認コードを発行します。

/code

POST

連携先定義

162

8

3 identity-verificate

本人性確認サービス

URL発行（新）本人性確認を行うUIのURLを発行します。

/url/issue

POST

userId: 利用者ID urlType: 発行URL種別 URL

163

8

4 identity-verificate

本人性確認サービス

利用者ID設定

対象の利用者連携について利用者IDの設定を行います。

/user/settings

POST

164

8

5 identity-verificate

本人性確認サービス

第三者による本人性確認

第三者による本人性確認を行います。

/verify/others/{identifyCode}

PUT

165

8

6 identity-verificate

本人性確認サービス

確認済本人性確認コード生成

確認済本人性確認コードを生成します。

/code/verified

166

8

7 identity-verificate

本人性確認サービス

発行URL確認

発行したURLの確認を行います。

167

8

8 identity-verificate

本人性確認サービス

本人性確認コード照合

168

91 ctoken-ledger

CToken台帳サービス

169

9

2 ctoken-ledger

CToken台帳サービス

CToken台帳の管理を行います。

identifyCode: 本人性確認コード userId: -(利用者情報を内部で設定し返却しな
利用者ID
い)identifyCode: 本人性確認コード status: -(本人性確認に成功したかは内部で処

運営メンバー
個人○

アプリケーション○

運営メンバー○

運営メンバー

ステータス

理し返却しない)

POST

利用者ID、連携先定義

確認済本人性確認コード○

運営メンバー/url/confirm

POST

URLのランダムパス

確認結果

○

個人

本人性確認コードを照合します。

/collate

POST

本人性確認コード照合結果○

すべてのオペレーター

CToken件数検索

CTokenの件数を取得します/count

POST

検索条件

検索結果

○

運営メンバー

CToken取得

CTokenを取得します

/

POST

検索条件

検索結果

○

個人
運営メンバー(APP)

Local CTokenサービスは、台帳へ連携する前の170

10

1 local-ctoken

Local-CTokenサービス

171

11

1 certification-authority

認証局サービス

172

12

1 certificate-manage

証明書管理サービス

情報を保存するサービス。
その情報は台帳サービスへ蓄積した履歴を連携する。
証明書の生成や取得、検証を行います。

なし

○

なし

証明書の保存を行います。
クライアント証明書アクティベートチェック
ブロック間通信用のAPIトークンを生成する処理○
クライアント証明書が登録されているか確認する。

/check/client

GET

なし

クライアント証明書の有無

○

○

○

○

○

運営メンバー

において、動的にリクエストの認可を行うサー173

13

1 access-control-manage

アクセス制御管理サービス

ビス。
否認するリクエストについてはAPIトークン生成

なし

○

なし

○

を終了し、認可したリクエストについては対象
ブロックからAPIトークンを取得する。
リクエストの認可において、それを得た際にお174

141 access-control

アクセス制御サービス

けるAPIトークンの発行・管理を行うサービス。
動的認可の一部(自ブロックでしか判別不可能な認可)に関しても責務がある。
バイナリファイルのアップロード、ダウンロー

175

15

1 binary-manage

バイナリ管理サービス

ファイル管理データを削除します。

/{manageId}

DELETE

manageId: 対象ファイル管理ID(UUID) 削除したファイル管理ID(UUID)

176

15

2 binary-manage

バイナリ管理サービス

（欠番）

177

15

3 binary-manage

バイナリ管理サービス

（欠番）

178

15

4 binary-manage

バイナリ管理サービス

（欠番）

179

15

5 binary-manage

バイナリ管理サービス

（欠番）

180

15

6 binary-manage

バイナリ管理サービス

ファイルダウンロード開始

ファイルダウンロードを開始します。

/download/start/{manageId}

POST

manageId: 対象ファイル管理ID(UUID)

181

15

7 binary-manage

バイナリ管理サービス

ファイルダウンロード終了

ファイルダウンロードを終了します。

/download/end/{manageId}

POST

manageId: 対象ファイル管理ID(UUID)

182

15

8 binary-manage

バイナリ管理サービス

ファイルダウンロードキャンセル

ファイルダウンロードを途中でキャンセルします。

/download/cancel/{manageId}

POST

manageId: 対象ファイル管理ID(UUID)

183

15

9 binary-manage

バイナリ管理サービス

ファイルダウンロード

ファイルをダウンロードします。

/download/{manageId}/{chunkNo}

POST

ドを行います。

ファイル管理データ削除

3 / 3 ページ

manageId: 対象ファイル管理ID(UUID)
ファイル分割No開始したファイル管理ID(UUID)
ファイル分割数終了したファイル管理ID(UUID)
処理結果
キャンセルしたファイル管理ID(UUID)
処理結果分割したファイルデータ(バイナリ)○

アプリケーション

○

個人

○

個人

○

個人

○

個人