API 사용 준비
카카오클라우드에서 제공하는 API(Application Programming Interface)를 사용하기 위해 수행해야 하는 사전 작업은 다음과 같습니다.
액세스 키 발급
IAM 사용자 자격 증명인 액세스 키(Access Key)는 액세스 키 ID와 보안 액세스 키를 의미하며, API 인증 토큰 발급을 위해 필요한 정보입니다.
발급 시 선택한 프로젝트에서 맡은 IAM 역할에 따라 액세스 키의 권한이 주어집니다.
액세스 키는 콘솔 우측 상단의 프로필 항목에서 발급받을 수 있으며, 자세한 발급 절차는 액세스 키 발급 문서를 참고하시기 바랍니다.
API 인증 토큰 발급
API 인증 토큰은 카카오클라우드 계정 아이디와 비밀번호를 대신하는 액세스 인증 토큰입니다. CLI나 API에서 API 인증 토큰을 사용하여 인증하고, 카카오클라우드 서비스를 이용할 수 있습니다.
API 인증 토큰을 발급받는 방법은 파라미터 구성에 따라 두 가지 방식으로 구분됩니다.
구분 | 필요한 파라미터 |
---|---|
API 인증 토큰 발급 방법 1 | 액세스 키 ID, 보안 액세스 키 |
API 인증 토큰 발급 방법 2 | 액세스 키의 이름, 보안 액세스 키, 사용자 고유 ID |
- API 인증 토큰을 발급받기 위해서는 액세스 키 발급이 선행되어야 합니다.
- 기본적으로 API 인증 토큰은 12시간 이후 만료되며, 상황에 따라 12시간 이내라도 변경되거나 만료될 수 있습니다.
API 인증 토큰 발급 방법 1
API 인증 토큰을 발급받는 첫 번째 방법에서는 액세스 키 ID와 보안 액세스 키를 사용합니다. 자세한 발급 방법은 다음과 같습니다.
-
액세스 키 발급을 참고하여 액세스 키를 발급받은 후, POST URL에 다음 경로를 입력합니다.
API 인증 토큰 발급 URLhttps://iam.kakaocloud.com/identity/v3/auth/tokens
-
JSON Body에 다음의 코드를 추가하고, 필요한 파라미터를 입력합니다.
API 인증 토큰 발급 방법 1{
"auth": {
"identity": {
"methods": [
"application_credential"
],
"application_credential": {
"id": "액세스 키 ID",
"secret": "보안 액세스 키"
}
}
}
}항목 필수 여부 설명 id 필수 액세스 키 ID
- 액세스 키 생성 시점 또는 액세스 키 목록에서 해당 액세스 키 항목을 클릭하여 조회 가능    secret 필수 보안 액세스 키
- 액세스 키 생성 시점에만 조회 가능 -
응답받은 Response Header의
X-Subject-Token
항목에서 발급된 API 인증 토큰을 확인합니다.
API 인증 토큰 발급 방법 2
API 인증 토큰을 발급받는 두 번째 방법에서는 액세스 키의 이름, 보안 액세스 키, 사용자 고유 ID를 사용합니다. 자세한 발급 방법은 다음과 같습니다.
-
액세스 키를 발급받은 후, POST URL에
https://iam.kakaocloud.com/identity/v3/auth/tokens
를 입력합니다.API 인증 토큰 발급 URLhttps://iam.kakaocloud.com/identity/v3/auth/tokens
-
JSON Body에 아래 코드를 추가하고, 필요한 파라미터를 입력합니다.
API 인증 토큰 발급 방법 2{
"auth": {
"identity": {
"methods": [
"application_credential"
],
"application_credential": {
"name": "액세스 키의 이름",
"secret": "보안 액세스 키",
"user": {
"id": "사용자 고유 ID"
}
}
}
}
}항목 필수 여부 설명 name 필수 액세스 키의 이름(직접 입력한 값)
- 카카오클라우드 콘솔 > 사용자 프로필 > 액세스 키에서 조회 가능secret 필수 보안 액세스 키
- 액세스 키 생성 시점에만 조회 가능user.id