OAuth 2.0 인증

모든 BizMessage API를 호출하기 전, 선제적으로 OAuth 2.0 API를 호출하여 인증을 진행해야 합니다. OAuth 2.0 API 호출 시, 계약 시 발급받은 클라이언트 정보(Client ID와 Client Secret)를 Authorization 헤더를 통해 전달하여 정보를 인증받아야 합니다.

안내

모든 BizMessage API를 호출하기 전, OAuth 2.0 인증 API를 선제적으로 호출해야 합니다.

API 기능별 예제는 Sample Code 문서를 참고하시기 바랍니다.

주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.

Request

Request Syntax

코드예제OAuth 2.0 인증 Request Syntax

Bash

curl -X POST "https://{base_url}/v2/oauth/token" \
        -H  "accept: */*" \
        -H  "Authorization: Basic {clientID} {clientSecret}" \
        -H  "Content-Type: application/x-www-form-urlencoded" \
        -d  "grant_type=client_credentials"

표API 호출 방식

메서드	요청 URL
POST	`https://{base_url}/v2/oauth/token`

표OAuth 2.0 인증 Path Parameter

파라미터	유형	필수 여부	대분류	구분	설명
base_url	String	`필수`	운영	일반	`bizmsg-web.kakaoenterprise.com`
				금융권	`bizmsg-bank.kakaoenterprise.com`
				증권	`bizmsg-stock.kakaoenterprise.com`
				공공 기관	`bizmsg-gov.kakaoenterprise.com`
			스테이징	일반	`stg-user.bizmsg.kakaoenterprise.com`
				금융권	`stg-bizmsg-bank.kakaoenterprise.com`
				증권	`stg-bizmsg-stock.kakaoenterprise.com`
				공공 기관	`stg-bizmsg-gov.kakaoenterprise.com`

Request Header

표OAuth 2.0 인증 Request Header

파라미터	타입	필수 여부	설명
accept	MIME	필수	`/`로 고정
Authorization	String	필수	Basic 클라이언트 정보 - `{clientId}`: 계약 시 발급받은 클라이언트 ID - `{clientSecret}`: 계약 시 발급받은 클라이언트 시크릿
Content-Type	String	필수	`application/x-www-form-urlencoded`로 고정 - 현재 전송하는 데이터의 유형을 표시

Request Elements

표OAuth 2.0 인증 Request Elements

프로퍼티	유형	필수 여부	설명
grant_type	String	필수	OAuth 2.0 인증방식 - `client_credentials`로 고정

Responses

Response Syntax

코드예제OAuth 2.0 인증 Response Syntax

JSON

{
  "code": "200",
  "result": {
    "detail_code": "NRM00000",
    "detail_message": "성공"
  },
  "access_token": "example-token",
  "token_type": "bearer",
  "expires_in": 863999
}

Response Elements

표OAuth 2.0 인증 Response Elements

프로퍼티	타입	필수 여부	설명
code	String	필수	토큰 발급 결과 코드
			`200`(OK): 성공, 토큰 정보 응답
			`201`(Created): 토큰이 생성됨
			`401`(Unauthorized): 권한 없음
			`403`(Forbidden): 서버가 요청을 거부함
			`404`(Not Found): 서버가 요청한 페이지(Resource)를 찾을 수 없음
	Object	필수	세부 결과 정보(참고용)
detail_code	String	필수	세부 결과 코드(참고용)
detail_message	String	필수	세부 결과 메시지(참고용)
access_token	String	필수	액세스 토큰 정보 - Token 획득 URL: `/v2/oauth/token`
token_type	String	필수	토큰 타입 - `bearer`로 고정
expires_in	Integer	필수	토큰의 유효 기간(단위: 초) - int32

안내
API 기능별 코드는 Sample Code 문서를 참고하시기 바랍니다.

kakaoIdocumentation

Kakao i Connect Message::BizMessage(KOR)::API 호출 방식::API 레퍼런스::OAuth 2.0 인증

페이지 이동경로