User Account Connectの概要
User Account Connectは、ユーザーのDOSIアカウントをパートナー企業のサービスに連携するAPIで、OAuth 2.0 Flowに準拠しています。 User Account Connect APIを使用すると、DOSIユーザーがゲームなどパートナー企業のサービスを利用可能になります。
接続情報
| 開発環境 | API base URI | Authorization endpoint |
|---|---|---|
| プロダクション環境 | https://api.dosi.world | https://members.dosi.world |
レスポンスモデル
User Account Connectは、HTTPステータスコードとAPIレスポンスコードでリクエストの処理結果を通知します。
HTTPステータスコード
一般的なステータスコードについては、以下の表を参照してください。
| HTTPステータスコード | 説明 |
|---|---|
| 200 OK | リクエストが成功しました |
| 400 Bad request | リクエストに問題があります |
| 401 Unauthorized | 認証に失敗しました |
| 500 Internal Server Error | サーバーにエラーが発生しました |
エラーレスポンス
各HTTPステータスコードのエラー情報の詳細は、レスポンスボディ（body）に以下の形式で返されます。
{
"responseCode": "<code>",
"errorMessage": "<message>"
}
responseCodeの詳細については、以下の表を参照してください。
errorMessageは、API実行結果から確認できます。
| HTTPステータスコード | APIレスポンスコード | 説明 |
|---|---|---|
| 400 | BAD_REQUEST | 引数（argument）として不正な値が指定されています |
| 401 | NO_AUTHORITY | |
| 500 | AUTH_API_UNKNOWN | 内部認証サーバーで不明なエラーが発生しました |
| 500 | AUTH_API_SERVER_ERROR | |
| 500 | FAILED_TO_LOGOUT | |
| 500 | INVALID_CHAIN_NAME | アクセストークンによるデジタルアイテム一覧の取得の際、chainNameに「realnet」以外の値を入力しました |
| 500 | NOT_FOUND | アクセストークンによるデジタルアイテム一覧の取得の際に指定したcontractIdまたはtokenTypeがありません |
| 500 | NOT_FOUND_MEMBER | ユーザーを取得できません |
| 503 | MAINTENANCE | メンテナンス中のため、リクエストを処理できません |