이 문서는 카카오 또는 공동체 서비스의 JavaScript SDK(Kakao SDK for JavaScript)를 사용한 사용자 정보 API 사용 방법을 안내합니다.

현재 로그인한 사용자의 카카오계정 정보를 불러옵니다.

자세한 안내와 예제는 사용자 정보 조회를 참고합니다.

사용자 프로퍼티에 값을 저장합니다.

자세한 안내와 예제는 사용자 프로퍼티 저장을 참고합니다.

사용자 카카오계정의 배송지 정보를 제공합니다. 배송지에서 자세한 안내를 확인한 후 사용할 것을 권장합니다.

카카오 로그인으로 토큰을 발급받은 후, 아래의 두 API를 순서대로 호출해 배송지 정보를 제공받을 수 있습니다.

1. 배송지 선택
2. 배송지 조회

사용자가 서비스에 제공할 배송지를 직접 선택할 수 있는 배송지 피커를 불러오고, 선택된 배송지의 ID를 제공합니다.

자세한 안내와 예제는 배송지 선택을 참고합니다.

배송지 ID에 해당하는 특정 배송지 또는 전체 배송지 목록을 제공합니다.

자세한 안내와 예제는 배송지 조회를 참고합니다.

사용자가 카카오계정에 새로운 배송지를 등록할 수 있는 배송지 피커를 불러오고, 추가된 배송지의 ID를 제공합니다. 이 기능을 사용하면 배송지 선택 과정 없이 곧바로 사용자에게 배송지 등록을 요청할 수 있습니다. 자세한 안내는 배송지를 참고합니다.

배송지 등록은 추가된 배송지의 ID만 제공하므로, 추가된 배송지 상세 정보를 받으려면 아래 두 가지 함수를 순서대로 요청해야 합니다.

1. 배송지 등록
2. 배송지 조회

Kakao.Auth.createShippingAddress() 함수를 호출합니다.

사용자가 배송지 피커에서 새로운 배송지 등록을 완료하면, 추가된 배송지의 ID가 반환됩니다. 반환된 배송지 ID로 배송지 조회 API를 요청해 배송지 상세 정보를 제공받을 수 있습니다.

에러 발생 시 에러 코드에서 원인을 확인합니다.

Kakao.Auth.createShippingAddress()
  .then(function (selectedAddress) {
    return Kakao.API.request({
      url: "/v1/user/shipping_address",
      data: {
        address_id: selectedAddress.address_id,
      },
    })
  })
  .then(function (response) {
    console.log(response)
  })
  .catch(function (error) {
    console.log(error)
  })

사용자가 카카오계정에 등록된 배송지를 수정할 수 있는 배송지 피커를 불러오고, 수정된 배송지의 ID를 제공합니다. 이 기능을 사용하려면 권한 및 동의항목 설정이 필요합니다. 자세한 안내는 배송지를 참고합니다.

배송지 수정은 수정된 배송지의 ID만 제공하므로, 수정된 배송지 상세 정보를 받으려면 아래 두 가지 함수를 순서대로 요청해야 합니다.

1. 배송지 수정
2. 배송지 조회

Kakao.Auth.updateShippingAddress() 함수를 호출합니다. 요청 시 addressId 파라미터로 수정할 배송지를 지정해야 합니다.

사용자가 배송지 피커에서 수정을 완료하면, 수정된 배송지의 ID가 반환됩니다. 반환된 배송지 ID로 배송지 조회를 요청해 수정된 최신 배송지 정보를 제공받을 수 있습니다.

에러 발생 시 에러 코드에서 원인을 확인합니다.

Kakao.Auth.updateShippingAddress({
  addressId: ${ADDRESS_ID},
})
  .then(function(selectedAddress) {
    return Kakao.API.request({
      url: '/v1/user/shipping_address',
      data: {
        address_id: selectedAddress.address_id,
      },
    });
  })
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

배송지 선택, 배송지 등록, 배송지 수정 요청 시 returnUrl 파라미터를 사용하면 리다이렉트(Redirect) 방식으로 현재 페이지에서 배송지 피커를 열 수 있습니다. 사용자가 입력 또는 선택을 완료하면, 서비스 서버의 returnUrl로 리다이렉트(HTTP 302 Redirect) 되면서 배송지 ID가 쿼리 문자열로 전달됩니다.

// 리다이렉트 방식
// 성공: ${RETURN_URL}?status=success&address_id=${ADDRESS_ID}
// 실패: ${RETURN_URL}?status=error&error_code=${ERROR_CODE}&error_msg=${ERROR_MESSAGE}
Kakao.Auth.selectShippingAddress({
  returnUrl: '${RETURN_URL}', // 필수
});

// 선택된 배송지 조회
// returnUrl로 리다이렉트 후 요청해야 함
Kakao.API.request({
  url: '/v1/user/shipping_address',
  data: {
    address_id: ${ADDRESS_ID},
  },
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });