본문으로 건너뛰기

API 개요

Pub/Sub API는 코드 기반의 프로그래밍 방식으로 자원들을 관리하기 위한 인터페이스입니다.
Pub/Sub에서 제공하는 API를 활용하면 반복적이고 자동화된 작업 또는 콘솔 브라우저로 수행하기 어려운 작업을 간편하게 처리할 수 있습니다. REST API, SDK Go를 통해 코드 기반으로 카카오클라우드의 Pub/Sub을 사용할 수 있습니다.

API 공통​

  • API 요청에 대한 응답은 JSON 형태로 제공합니다.
  • API 사용을 위해서는 액세스 키 ID와 보안 액세스 키를 발급받아야 합니다.
주의

액세스 키를 발급받은 프로젝트에 속해있는 리소스에만 접근할 수 있습니다.
따라서 API 호출 시에 domain, project는 발급받은 액세스 키가 포함되어 있는 정보로 설정해야 합니다.

Default-Topic과 Default-Topic에 연결된 서브스크립션의 경우 해당 페이지의 API 요청이 불가하며, 메시지 수신하기에서 안내된 Pull/Acknowledge 요청만 가능합니다.

사전 작업​

Pub/Sub에서 제공하는 API를 사용하기 위해서는 다음의 사전 작업을 수행해야 합니다.

액세스 키 발급하기​

사용자 인증 토큰(API 인증 토큰)을 획득하기 위해서는 먼저 액세스 키를 발급받은 후, 액세스 키 ID와 보안 액세스 키를 발급합니다.

  1. 카카오클라우드 콘솔 > 사용자 프로필 > 액세스 키 탭에서 사용자의 자격 증명으로 액세스 키를 발급합니다.

  2. 액세스 키를 발급한 후, 액세스 키 ID와 보안 액세스 키를 발급합니다.

API 엔드포인트 URL​

API 사용을 위한 Pub/Sub 엔드포인트 URL은 다음과 같습니다.

Pub/Sub 엔드포인트 URL 형식
# kr-central-1
https://pub-sub.kr-central-1.kakaocloud.com

# kr-central-2
https://pub-sub.kr-central-2.kakaocloud.com