OAuth 2.0

리소스 오너 (Resource Owner)

쇼핑몰의 소유자를 의미하며 클라이언트에게 권한을 위임합니다.

클라이언트 (Client)

리소스 오너의 권한을 위임받아 리소스 오너의 데이터를 접근하거나 사용하는 앱입니다.

인증 서버 (Authorization Server)

리소스 오너의 인증을 처리하고 클라이언트에게 액세스 토큰을 발급하는 서버입니다.

리소스 서버 (Resource Server)

발급 받은 액세스 토큰으로 리소스 오너의 데이터를 제공하는 서버입니다.

GET

https://openapi.imweb.me/oauth2/authorize

responseType

String

code로 고정

O

clientId

String

아임웹으로부터 발급 받은 클라이언트 ID

O

redirectUri

String

인가 코드를 전달받을 URI

O

scope

String

접근이 필요한 권한을 공백으로 구분하여 전달

O

state

String

아임웹 OAuth2.0 인증 과정 중 동일한 값을 유지하는 임의의 문자열입니다.

CSRF 공격으로부터 보호하기 위해 사용합니다.

X

siteCode

String

쇼핑몰 사이트 코드

O

code

String

토큰 발급 요청 시 필요한 인가 코드

O

state

String

요청 시 전달한 state 값과 동일한 값

X

errorCode

String

인가 코드 요청 실패 시 반환되는 에러 코드

O

message

String

인가 코드 요청 실패 시 반환되는 에러 메시지

X

POST

https://openapi.imweb.me/oauth2/token

grantType

String

authorization_code로 고정

O

clientId

String

아임웹으로부터 발급 받은 클라이언트 ID

O

clientSecret

String

아임웹으로부터 발급 받은 클라이언트 앱 Secret

O

redirectUri

String

인가 코드가 리다이렉트된 URI

O

code

String

인가 코드 발급 요청으로 받은 인가 코드

O

accessToken

String

아임웹 API 호출 시 필요한 Access Token 값

O

refreshToken

String

토큰 재발급 시 사용되는 Refresh Token 값

O

scope

String[]

Access Token으로 요청 가능한 권한 범위

O

errorCode

String

토큰 발급 요청 실패 시 반환되는 에러 코드

O

message

String

토큰 발급 요청 실패 시 반환되는 에러 메시지

X

POST

https://openapi.imweb.me/oauth2/token

grantType

String

refresh_token로 고정

O

clientId

String

아임웹으로부터 발급 받은 클라이언트 ID

O

clientSecret

String

아임웹으로부터 발급 받은 클라이언트 앱 Secret

O

refreshToken

String

토큰 발급 시 발급 받은 Refresh Token

O

accessToken

String

아임웹 API 호출 시 필요한 Access Token 값

O

refreshToken

String

토큰 재발급 시 사용되는 Refresh Token 값

O

scope

String[]

Access Token으로 요청 가능한 권한 범위

O

errorCode

String

토큰 발급 요청 실패 시 반환되는 에러 코드

O

message

String

토큰 발급 요청 실패 시 반환되는 에러 메시지

X