OAuth 2.0으로 API 연동하기

1) 클라이언트 앱 등록

먼저 클라이언트는 리소스 서버에 앱을 등록해야 합니다. 이 과정에서 Client ID와 Client Secret이 생성되는데요, 이 값들은 추후 인증 서버에 인증을 요청할 때 자신을 증명하는데 사용됩니다. 앱 등록 시 입력한 Redirect URI는 인증 서버가 요청에 대한 응답을 보낼 경로가 됩니다.

2) Access Token 을 위한 인증 코드 발급

Access Token이란 API로 데이터를 요청할 때, 리소스 서버에서 클라이언트가 해당 데이터에 대한 접근 권한이 있는지 확인할 수 있는 키입니다. 따라서 API 사용 시 중요한 필수값이라고 할 수 있는데요, Access Token을 받기 위해서는 먼저 인증 코드가 필요합니다. 인증 코드의 사용은 Access Token의 노출을 피하기 위한 과정이라고 할 수 있습니다. 리소스 소유자가 클라이언트 앱을 실행하여 권한 위임에 대한 동의를 하면, 클라이언트는 인증 서버에 인증 코드를 요청합니다. 인증 서버는 클라이언트 검증 후 인증 코드를 발급하여 Redirect URI로 반환합니다.

인증 코드 Request

https://{mall_id}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={encode_csrf_token}&redirect_uri={encode_redirect_uri}&scope={scope}

인증 코드 Response

{redirect_uri}?code={authorization_code}&state={encode_csrf_token}

3) Access Token 발급

클라이언트는 인증 코드를 사용하여 인증 서버에 Access Token을 요청합니다. 인증 서버는 Access Token을 Refresh Token 등과 함께 반환합니다. Access Token의 유효 기간은 2시간이고, 만료 시 Refresh Token을 사용하여 재발급 받습니다. Refresh Token도 만료된 경우 재인증이 필요합니다.

Access Token Request 형식

curl -X POST
'https://{mall_id}.cafe24api.com/api/v2/oauth/token'
-H 'Authorization: Basic {base64_encode({client_id}:{client_Secret})}'
-H 'Content-Type: application/x-www-form-urlencoded'
-d 'grant_type=authorization_code'
-d 'code={authorization_code}'
-d 'redirect_uri={redirect_uri}'

Access Token Response

{
  "access_token": "{access_token}",
  "expires_at": "{expiration_date_of_access_token}",
  "refresh_token": "{refresh_token}",
  "refresh_token_expires_at": "{expiration_date_of_refresh_token}",
  "client_id": "{client_id}",
  "mall_id": "{mall_id}",
  "user_id": "{user_id}",
  "scopes": [
    "{scopes_1}",
    "{scopes_2}"
  ],
  "issued_at": "{issued_date}"
}

4) API 요청을 통한 데이터 획득

이제 Access Token을 사용하여 필요한 데이터에 대한 API 요청을 보내고 응답을 받을 수 있습니다. 예를 들어 리소스 소유자 카페24 쇼핑몰에 등록된 쇼핑몰 정보에 대한 데이터를 요청한다고 하겠습니다. 클라이언트는 리소스 서버에 쇼핑몰 정보를 조회하는 API 요청 주소를 Access Token과 함께 호출합니다. Access Token이 유효하다면 리소스 서버는 해당 정보를 반환하고, 리소스 소유자는 요청한 정보를 클라이언트로부터 확인할 수 있게 됩니다.

쇼핑몰 정보 조회 Request 형식

curl -X GET \
  'https://{mallid}.cafe24api.com/api/v2/admin/store?shop_no=1' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'X-Cafe24-Api-Version: {version}'

쇼핑몰 정보 조회 Response

{
    "store": {
        "shop_no": 1,
        "shop_name": "My Shopping Mall",
        "mall_id": "myshop",
        "base_domain": "sample.cafe24.com",
        "primary_domain": "sample.com",
        "company_registration_no": "118-81-20586",
        "company_name": "My Shopping Mall",

         ...(생략)
    }
}