Classic/VPC環境で利用できます。
Access Tokenを発行したり、更新する APIです。B2B PRISM Live Studioでの使用フローを確認するには、ログインプロセスをご参照ください。
リクエスト
リクエスト形式は次の通りです。
GET {serviceApiDomain}/prism/v1/service/oauth2/token
リクエストヘッダ
ヘッダの説明は次の通りです。
| 名前 | タイプ | 説明 | 必須の有無 |
|---|---|---|---|
| x-prism-client-id | String | 顧客のサービスにおいて、B2B PRISM Live Studioへの OAuth 2.0認証用に提供される、クライアント IDに変更されない値 | Y |
| x-prism-client-secret | String | 顧客のサービスにおいて、B2B PRISM Live Studioへの OAuth 2.0認証用に提供される、クライアント Secretで、セキュリティ上の問題などの理由により、必要に応じて協議の上変更可能 | Y |
リクエストクエリパラメータ
パラメータの説明は次の通りです。
| 名前 | タイプ | 説明 | 必須の有無 |
|---|---|---|---|
| grant_type | String | OAuth 2.0権限付与タイプで、Access Token発行時には「authorization_code」、更新時には「refresh token」を使用 | Y |
| redirect_uri | String | grant_type = authorization_codeでリクエストする際に必要で、B2B PRISM Live Studioではhttps://global.apis.naver.com/prism/prism-auth-api/oauth/partner/{serviceId}を使用 |
N |
| code | String | Access Token発行時、redirect uriでレスポンスを受けた codeを渡す | N |
| _token | String | grant_type = refresh_tokenでリクエストする場合に使用 | N |
レスポンス
レスポンス形式を説明します。
| 名前 | タイプ | 説明 | 必須の有無 |
|---|---|---|---|
| access_token | String | ユーザーの Access Token | Y |
| refresh_token | String | ユーザーの Refresh Token | N |
| expires_in | Number | Access Tokenの有効期限までの残り時間(秒) | N |
| token_type | String | トークンのタイプ、一般的には「bearer」 | Y |
例
構文の例を紹介します。
Access Tokenの発行時
Access Tokenの発行に関する構文例を紹介します。
リクエスト例
構文のサンプルコードは次の通りです。
curl -X GET {serviceApiDomain}/prism/v1/service/oauth2/token
?grant_type=authorization_code
&code={your_authorized_code} \
-H "x-prism-client-id: {client-id}"
-H "x-prism-client-secret: {client-secret}"
レスポンス例
構文のサンプルコードは次の通りです。
{
"access_token": "JXvBU54_hOok4gpOTHAOASEHbaE",
"expires_in": 12345,
"refresh_token": "va32t62Zsc3DVv0irdCt3yBjy_c",
"token_type": "bearer"
}
Access Tokenの更新時
Access Tokenの更新に関する構文例を紹介します。
リクエスト例
構文のサンプルコードは次の通りです。
curl -X GET {serviceApiDomain}/prism/v1/service/oauth2/token
?grant_type=refresh_token
&refresh_token={your_refresh_token} \
-H "x-prism-client-id: {client-id}"
-H "x-prism-client-secret: {client-secret}"
レスポンス例
構文のサンプルコードは次の通りです。
{
"access_token": "JXvBU54_hOok4gpOTHAOASEHbaE",
"expires_in": 12345,
"refresh_token": "va32t62Zsc3DVv0irdCt3yBjy_c",
"token_type": "bearer"
}