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に OAuth2.0認証のために提供するクライアント IDで、変更されない値 | Y |
| x-prism-client-secret | String | 顧客のサービスで B2B PRISM Live Studioに OAuth2.0認証のために提供するクライアント Secretで、セキュリティ問題などの理由で必要な場合に協議を通じて変更可能 | Y |
リクエストクエリパラメータ
パラメータについての説明は、次の通りです。
| 名前 | タイプ | 説明 | 必須有無 |
|---|---|---|---|
| grant_type | String | OAuth2.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 |
| refresh_token | String | grant_type = refresh_tokenでリクエストする場合に使用 | N |
レスポンス
レスポンス形式を説明します。
| 名前 | タイプ | 説明 | 必須有無 |
|---|---|---|---|
| access_token | String | ユーザーの Access Token | Y |
| refresh_token | String | ユーザーの Refresh Token | Y |
| 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=refresth_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"
}