API 개요
Pub/Sub API는 코드로 리소스를 관리하기 위한 인터페이스입니다.
Pub/Sub API를 활용하면 반복 작업을 자동화하고 콘솔에서 수행하기 어려운 작업을 간편하게 처리할 수 있습니다. REST API와 Go SDK를 통해 카카오클라우드 Pub/Sub을 사용할 수 있습니다.
API 버전
Pub/Sub API는 v1과 v2로 제공됩니다. v1과 v2는 기능적으로 동일하며, 신규 연동 시에는 v2 사용을 권장합니다.
주의
Pub/Sub API v1은 일정 기간 병행 제공된 후 종료(deprecated)될 예정입니다. 종료 일정은 추후 별도 공지될 예정입니다.
API 공통
- API 요청에 대한 응답은
JSON형태로 제공합니다. - API 사용을 위해서는 액세스 키 ID와 보안 액세스 키를 발급받아야 합니다.
주의
액세스 키를 발급한 프로젝트에 속한 리소스에만 접근할 수 있습니다.
API v1을 호출할 때는 domain과 project를 액세스 키가 속한 조직과 프로젝트의 정보로 설정해야 합니다.
사전 작업
Pub/Sub에서 제공하는 API를 사용하려면 다음의 사전 작업을 수행해야 합니다.
IAM 액세스 키 발급하기
사용자 인증 토큰(API 인증 토큰)을 획득하려면 먼저 액세스 키를 발급한 후 액세스 키 ID와 보안 액세스 키를 확인합니다. 자세한 내용은 API 사용 준비 문서를 참고하세요.
-
액세스 키를 발급한 후, 생성된 액세스 키 ID와 보안 액세스 키를 확인합니다.
API 엔드포인트 URL
API 사용을 위한 Pub/Sub 엔드포인트 URL은 다음과 같습니다.
Pub/Sub 엔드포인트 URL 형식
https://pub-sub.kr-central-2.kakaocloud.com