ログインと認証機能

User Account Connect APIを使用してパートナー企業のサービスからユーザーのDOSIアカウントでログインできます。

接続情報

開発環境	API base URI
プロダクション環境	https://api.dosi.world

使用手順

DOSIユーザーがパートナー企業のサービスにログインするようにしたり、ユーザー情報を取得したりするには、以下の手順に従う必要があります。

GoogleアカウントでDOSIにログインするには、Gmailアカウントを使用します。Google Workspaceアカウントは使用できません。

1.DOSIユーザー認証のリクエスト

Authorization endpoint（https://members.dosi.world）に認証リクエストを送信してください。その際、以下のサービス情報をクエリパラメータとして渡す必要があります。

パラメータ	説明
client_id	DOSI SDK利用申請後に受け取ったDOSIのチャネルID
state	OAuth Flow検証用のランダムな文字列
mode	OAuth Flowモード。常に"oauth"にしてください。
redirect_uri	ユーザーログイン後にリダイレクトするURI
scope	提供されるユーザープロフィール情報グループ。常に"basic"にしてください。
code_challenge	PKCEで使用するcode challengeの値。クライアントがモバイルアプリの場合は、必ず指定する必要があります。
code_challenge_method	文字列の暗号化方法。クライアントがモバイルアプリの場合は、必ず入力する必要があります。値は常に"S256"です。

以下は呼び出しの例です。

https://members.dosi.world?client_id=17XEvciBbskwvvddn0m_&state=hiubweiriuqukjdsfsdrwe&mode=oauth&redirect_uri=https%3A%2F%2Fprofile.dosi.world%2F

DOSIは、このリクエストを受け取ると、サービス接続承認画面（ログインしていない場合はログイン画面）を表示します。ユーザーがその画面で作業を承認すると、DOSIはredirect_uriで認証コード（authorization code）を発行します。

2.アクセストークンの処理

1の作業が完了した後、発行された認証コードでアクセストークン（access token）を発行します。アクセストークンを発行または更新エンドポイントでリクエストできます。

3.ユーザープロフィールの取得

2の作業後、発行されたアクセストークンでユーザープロフィールを取得します。ユーザーの拡張プロフィールの取得エンドポイントでプロフィールをリクエストできます。

アクセストークンの発行または更新

認証コード（authorization code）でアクセストークン（access token）を発行、またはリフレッシュトークン（refresh token）でアクセストークンを更新します。

POST {API base URI}/api/v1/oauth2/token

Request

Response

Path

None

Query

None

Body

Name	Type	Description	Required
grant_type	string	リクエストタイプ。以下のいずれかを選択してください。 "authorization_code"：アクセストークンの発行をリクエストする "refresh_token"：アクセストークンの更新をリクエストする
code	string	アクセストークンを発行するユーザーの認証コード。grant_typeが"authorization_code"の場合のみ指定してください。 DOSI認証リクエストで送信されるredirect_uriから認証コードを取得できます。
client_id	string	DOSI SDK利用申請後に取得したDOSIのチャネルID
client_secret	string	DOSI SDK利用申請後に取得したDOSIのチャネルシークレット
refresh_token	string	アクセストークンを更新するリフレッシュトークン。grant_typeが"refresh_token"の場合のみ指定してください。 リフレッシュトークンは、このエンドポイントを呼び出し、最初にアクセストークンが発行されるときに取得できます。 必ず最新のリフレッシュトークンを入力してください。期限切れのリフレッシュトークンを送信すると、リフレッシュトークン保護ルールに従って、すべてのアクセストークンとリフレッシュトークンが無効になるため、ユーザーは再度認証を受ける必要があります。
code_verifier	string	クライアントによる自己認証のために生成されるランダム文字列。エントロピーの高いランダムな値を入力する必要があります。参考資料を確認してください。 クライアントがモバイルアプリの場合は、必ず指定する必要があります。

Headers

• Content-Type: application/x-www-form-urlencoded

Request examples

発行リクエスト

更新リクエスト

curl -v -X POST "https://api.dosi.world/api/v1/oauth2/token" \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=authorization_code' \
  -d 'code=b5fd32eacc791df' \
  -d 'client_id=12345' \
  -d 'client_secret=d6524edacc8742aeedf98f'

Name	Type	Description	Included
access_token	string	発行されたアクセストークン
expires_in	number	access_token値の有効期限までの残り秒数
refresh_token	string	リフレッシュトークン。このエンドポイントを使用して、アクセストークンを更新します。このトークンは、90日間有効です。
token_type	string	トークンタイプ。常に固定値の"Bearer"を返します。

Response status code

200 OK

Response headers

None

Related errors

• BAD_REQUEST
• AUTH_API_UNKNOWN
• AUTH_API_SERVER_ERROR

Response examples

発行リクエストの結果

更新リクエストの結果

{
  "access_token":"9b_7EjklljIR2EpqLA8D0ci1HftZSqsIfAMCUKMDKNWA44BGshJssw7lrZN1dQJ-ZNFJ-jd3hSO1MuLTt_2OSe2PXcL-IZwi7RinnoOzk0R_aw_BdoY9oKaBz_NGcNJBugUZPDntnHv8TH9cNpvZ8qjcElLa0B-5rcW0dreZFCA",
  "expires_in":604800,
  "refresh_token":"6201582b-050d-4120-9c84-7cb972b10e6a",
  "token_type":"Bearer"
}

アクセストークンの破棄

発行されたアクセストークン（access token）とリフレッシュトークン（refresh token）を破棄します。

POST {API base URI}/api/v1/oauth2/revoke

Request

Response

Path

None

Query

None

Body

None

Headers

• Authorization: Bearer <access token>

Request examples

curl

curl -v -X POST "https://api.dosi.world/api/v1/oauth2/revoke" \
  -H 'Authorization: Bearer <access token>'

None

Response status code

200 OK

Response headers

None

Related errors

• FAILED_TO_LOGOUT
• AUTH_API_UNKNOWN
• AUTH_API_SERVER_ERROR

ユーザーの拡張プロフィールの取得

アクセストークンを利用してユーザーの拡張プロフィール（extended profile）を取得します。

GET {API base URI}/api/v2/profile/extended

Request

Response

Path

None

Query

None

Body

None

Headers

• Authorization: Bearer <access token>

Request examples

curl

curl -v -X GET "https://api.dosi.world/api/v2/profile/extended" \
  -H 'Authorization: Bearer <access token>'

Name	Type	Description	Included
userId	string	DOSIユーザーのユニークID。[a-f0-9]{64}の正規表現にマッチする文字列です。
email	string	ユーザーのメールアドレス
pictureUrl	string	ユーザーのプロフィール写真URL
displayName	string	ユーザーが設定した表示用の名前
extended	object	拡張プロフィール

Response status code

200 OK

Response headers

None

Related errors

None

Response examples

{
  "userId" : "6e06036d94598143a6b024aa45e97174da4a96fa06c743532d987c156d5f2d10",
  "email" : "mynameis@dosi.world",
  "pictureUrl" : "https://vos.line-scdn.net/global-nft-prod/profile-image/img_profile_default_02.png",
  "displayName" : "DosiUser1",
  "extended": {
    "walletAddress": "link1vhyua9t40fskhx7f72yesxgxaq5wcr57p2p5rp",
  }
}