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"
}