API v1.1 가이드 - NHN Cloud 사용자 가이드

Management > Certificate Manager > API v1.1 가이드

Certificate Manager에서는 인증서 목록 조회, 다운로드를 위한 API를 제공합니다. 클라이언트는 콘솔에서 인증서와 인증서 파일을 등록한 후 API를 통해 데이터를 사용할 수 있습니다.

기본 정보

EndPoint

https://certmanager.api.nhncloudservice.com

제공하는 API 종류

메서드	URI	설명
GET	/certmanager/v1.1/appkeys/{appKey}/certificates	인증서 목록을 조회합니다.
GET	/certmanager/v1.1/appkeys/{appKey}/certificates/{certificateName}/files	등록된 인증서 파일을 다운로드합니다.

API의 요청의 HTTP 헤더

v1.1에서는 HTTP 헤더에 필수 필드가 추가됩니다.

X-TC-AUTHENTICATION-ID: {User Access Key ID}
X-TC-AUTHENTICATION-SECRET: {Secret Access Key}

자세한 사항은 콘솔 사용 가이드를 참고하십시오.

API 요청의 경로 변수

값	타입	설명
appKey	String	사용할 데이터를 저장하고 있는 NHN Cloud 프로젝트의 앱키
certificateName	String	사용할 데이터(인증서)의 이름

API 응답의 데이터 공통 헤더

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {

    }
}

값	타입	설명
resultCode	Number	API 호출 결과 코드값
resultMessage	String	API 호출 결과 메시지
isSuccessful	Boolean	API 호출 성공 여부

인증서 목록 조회

Certificate Manager에 등록한 인증서 목록을 조회할 때 사용합니다.

요청

GET https://certmanager.api.nhncloudservice.com/certmanager/v1.1/appkeys/{appKey}/certificates?pageSize={pageSize}&pageNum={pageNum}&all={all}&status={status}

값	타입	설명	입력 가능
pageSize	Number	페이지 크기	10(default)
pageNum	Number	페이지 번호	1(default)
all	Boolean	전체 조회 여부	true, false(default)
status	String	인증서 상태	ALL, EXPIRED, UNEXPIRED(default)

※ all, status의 값은 대소문자 구분 없이 사용할 수 있습니다.

응답

[Response Header]

Content-Type:application/json

[Response Body]

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "totalCount": 1,
        "totalPage": 1,
        "currentPage": 1,
        "pageSize": 10,
        "data": [
            {
                "certificateName": "test.nhn.com",
                "authority": "NHN",
                "signatureAlgorithm": "SHA256withRSA",
                "fileCreationDate": "2020-03-02",
                "expirationDate": "2021-03-25"
            }
        ]
    }
}

값	타입	설명
totalCount	Number	전체 인증서 수
totalPage	Number	전체 페이지 수
currentPage	Number	현재 페이지
pageSize	Number	페이지 크기
certificateName	String	인증서 이름
authority	String	인증 기관
signatureAlgorithm	String	서명 방식
fileCreationDate	String	인증서 파일 생성일
expirationDate	String	인증서 파일 만료일

인증서 파일 다운로드

Certificate Manager에 등록한 인증서 파일을 다운로드할 때 사용합니다.

요청

GET https://certmanager.api.nhncloudservice.com/certmanager/v1.1/appkeys/{appKey}/certificates/{certificateName}/files

응답