ユーザーアカウント連携状態の検証
DOSI SDKでは、ユーザー関連の処理またはユーザー情報の取得を行う際に、ユーザーウォレットがその作業を処理できる状態かどうかを事前に検証します。 検証結果が処理できない状態の場合、エラーレスポンスが返されます。
APIを呼び出す前にパートナー企業側で状態を直接確認できます。ユーザーアカウント連携状態の取得エンドポイントを使用してください。
ユーザーアカウントの連携状態
状態の種類は以下のとおりです。
状態名 | 説明 | API呼び出し制限 |
|---|---|---|
Channel Linkage Available | ユーザーがパートナー企業のDOSIチャネルとの連携に同意し、サービスを受けることができる状態。 この状態になるには以下の2つの条件を満たす必要があります。
|
|
No User Agreement | ユーザーがパートナー企業のDOSIチャネルとの連携に同意していないか、またはその同意を取り消し、サービスを受けることができない状態 |
|
User Suspended | ユーザーアカウントが一時的に停止され、サービスを受けることができない状態 |
|
User Unregistered | ユーザーアカウントが削除され、サービスを受けることができない状態 |
|
今後、状態の種類が増える可能性があります。
エラーレスポンス
ユーザーアカウント連携状態の検証に失敗してAPIを利用できない場合、以下のエラーレスポンスが返されます。
HTTPステータスコード：409 Conflict
HTTPレスポンスボディ（JSON形式）
名前
タイプ
説明
注意事項
responseCodeString
ユーザーアカウントの連携状態。以下のいずれかです。
- NO_USER_AGREEMENT
- USER_SUSPENDED
- USER_UNREGISTERED
このドキュメントに記載されていない値を受け取った場合は無視してください。
今後、状態の種類が増える可能性があります。
errorMessageString
詳細エラーメッセージ
人が理解するための情報なので、事前通知なしに変更されることがあります。クライアント側でデータを処理する際にこのメッセージを使用しないでください。
レスポンスの例
以下はユーザーアカウント連携状態の検証に失敗した場合のレスポンスの例です。
No User Agreement
{
"responseCode": "NO_USER_AGREEMENT",
"errorMessage": "*** This is a message for human readers, not for computers. ***"
}
User Suspended
{
"responseCode": "USER_SUSPENDED",
"errorMessage": "*** This is a message for human readers, not for computers. ***"
}
User Unregistered
{
"responseCode": "USER_UNREGISTERED",
"errorMessage": "*** This is a message for human readers, not for computers. ***"
}
検証対象エンドポイント
以下の表は、ユーザーアカウント連携状態の検証対象となるエンドポイントごとに、状態による実行可否を示しています。
| エンドポイント | Channel Linkage Available | No User Agreement | User Suspended | User Unregistered |
|---|---|---|---|---|
| プロキシ（proxy）ステータスの取得 | ||||
| プロキシ（proxy）設定のリクエスト | ||||
| プロキシ（proxy）設定リクエストのコミット | ||||
| プロキシ（proxy）設定中に認証ステータスを取得 | ||||
| デジタルアイテム一覧の取得（deprecated） | ||||
| デジタルアイテム一覧の取得 | ||||
| シーリング（Sealing） | ||||
| バッチシーリング（Batch sealing） | Note | Note | Note | Note |
| アンシーリング（Unsealing） | ||||
| バッチアンシーリング（Batch unsealing） | ||||
| 再シーリング（Resealing） | ||||
| ユーザーが販売中のデジタルアイテム一覧の取得 | ||||
| ユーザーが販売中のデジタルアイテムを販売中止 | ||||
| 販売中止のステータスの取得 |
バッチシーリングの実行条件
ユーザーウォレットを2つ以上指定した場合、すべてのユーザーウォレットの連携状態が条件を満たしている必要があります。