How to Use Postman with Couchbase Capella Public API

중요 공지: V3 API가 곧 지원 중단되며, 지원 종료일 이후에는 더 이상 업데이트나 지원을 받지 못함을 알려드립니다. 향상된 기능과 개선된 성능의 혜택을 누리실 수 있도록 새로운 V4 API로 전환하실 것을 강력히 권장합니다. 저희는 다음을 준비했습니다: V4 사용을 시작하는 방법에 대한 단계를 자세히 설명하는 종합 가이드 과정을 최대한 원활하게 진행하기 위해.

카우치베이스 카펠라는 관리자와 개발자가 다양한 프로그래밍 언어와 플랫폼을 사용하여 제어 평면(Control Plane)을 통합하고 상호 작용할 수 있도록 지원하는 공개 API를 제공합니다.. RESTful API는 고객이 Couchbase Capella와 통합하고 다음과 같은 작업을 수행할 수 있도록 지원합니다.

사용자 온보딩 및 오프보딩
데이터베이스 수명 주기 관리
데이터베이스 모니터링

이 블로그 게시물에서는 활용하는 방법을 보여드립니다 포스트맨 API 클라이언트 REST 인터페이스를 통해 Couchbase Capella 공개 API와 상호작용하기 위해.

이 튜토리얼은 카펠라 공개 API v3를 사용합니다. 호환성이 깨지는 변경사항이 도입될 수 있는 개편된 버전의 API가 준비 중입니다. 따라서 이 버전의 API는 이전 버전과의 호환성을 보장하지 않으므로 프로덕션 배포에 사용하는 것을 권장하지 않습니다. 그러나 API를 평가하고 새 버전의 공개 API에서 지원되기를 원하는 기능에 대한 피드백을 제공해 주시는 것을 권장합니다.

전제 조건

Postman은 REST API와 상호작용하기 위한 훌륭한 도구입니다. 이 튜토리얼의 남은 부분에서는 사용자가 Postman을 로컬에 설치했으며 사용할 준비가 되어 있다고 가정합니다. 다음에서 다운로드할 수 있습니다. postman.com/downloads
다음 단계는 Capellla에서 Couchbase Capella의 OpenAPI 파일을 다운로드하는 것입니다. 문서 사이트.

공개 API를 사용하려면 액세스 키와 시크릿 키도 생성해야 합니다. 키 설정 방법에 대한 지침을 참조하세요. 여기.

새로운 Postman 환경 만들기

이 단계에서는 새 Postman 환경(Postman 요청에서 사용할 수 있는 변수 모음)을 설정합니다. Couchbase Capella의 공개 API에는 액세스 키와 비밀 키가 필요합니다.

변수 이름을 정확히 다음과 같이 지정해야 합니다:

액세스 키 액세스 키가 포함된
비밀 키 당신의 비밀을 담은

이 새로운 환경을 활성 환경으로 설정하는 것이 아마 가장 좋을 것입니다.

OpenAPI 정의 가져오기

다음 단계는 아까 다운로드한 OpenAPI 정의 파일을 가져오는 것입니다. 이렇게 하면 새로운 Postman 컬렉션이 생성됩니다.

이 시점에서 Postman에 컬렉션과 환경이 설정되었습니다.

인증 구성

Couchbase Capella Public API는 소지자 토큰 인증 메커니즘; 퍼블릭 API에 대한 각 호출은 인증되어야 합니다. 모든 요청에 전송해야 하는 두 개의 헤더에 대한 세부 정보는 다음에서 확인할 수 있습니다. 공식 문서 보안 헤더에 관하여.

시작하는 데 도움을 드리기 위해, 액세스 및 시크릿 키를 기반으로 필요한 헤더를 생성하는 Postman 사전 요청 스크립트를 제공합니다.

이 코드를 복사하여 다음 곳에 붙여넣어야 합니다: 사전 요청 스크립트 컬렉션 섹션. 사전 요청 스크립트에 대한 자세한 정보는 다음을 방문하여 확인할 수 있습니다. Postman의 문서 사이트.

// Grab the current endpoint infro from the request
const url = pm.request.url.getPathWithQuery()

// Grab the method from the request
const method = pm.request.method;

// Create a timestamp
const now = new Date().getTime();

// Datetime in the past
const yesterday = new Date();
yesterday.setDate(yesterday.getDate() – 1);

// SHA-256 hash 
const createHash = (payload, secret) => {
    return CryptoJS.HmacSHA256(payload, secret)
                    .toString(CryptoJS.enc.Base64);
}

// Create the bearerToken
const setToken = (accessKey, hash) => {
    pm.environment.set(“bearerToken”, accessKey + ‘:’ + hash);
}

// Create the Timestamp header
const setTimestampheader = (date) => {
    pm.request.headers.add({
    key: “Couchbase-Timestamp”,
    value: date
    });    
}

// If accessKey and secretKey are defined, we can generate the hash
if (pm.environment.has(“accessKey”) && pm.environment.has(“secretKey”)) {    
    // Replace variables in the URL
    const parsedURL = pm.variables.replaceIn(url);

    // Generate the payload
    const payload = [method, parsedURL, now].join(“n”);
    console.log(“Payload”, payload);

    // Generate the hash
    const hash = createHash(payload, pm.environment.get(“secretKey”))

    // Save the token to an env variable    
    setToken(pm.environment.get(“accessKey”), hash);

    // Add the timestamp header to the request
    setTimestampheader(now);
}

pm.environment.set(“yesterday”, yesterday.toJSON());
pm.environment.set(“now”, new Date().toJSON());

// 요청에서 현재 엔드포인트 정보를 가져옵니다.

상수 URL = 오후.요청.URL.getPathWithQuery()

// 요청에서 메서드를 가져옵니다.

상수 방법 = 오후.요청.방법;

타임스탬프 생성하기

상수 지금 = 새로운 날짜().시간 가져오기();

// 과거의 날짜와 시간

상수 어제 = 새로운 날짜();

어제.날짜 설정(어제.날짜 가져오기() – 1);

// SHA-256 해시

상수 해시생성 = (페이로드, 비밀) =< {

반환 CryptoJS.HmacSHA256(페이로드, 비밀)

.문자열로변환(CryptoJS.인코딩.베이스64);

}

// 베어러 토큰 생성

상수 토큰설정 = (액세스 키, 해시) =< {

오후.환경.설정(“Bearer 토큰”, 액세스 키 + ‘:’ + 해시);

}

// 타임스탬프 헤더 생성

상수 타임스탬프 헤더 설정 = (날짜) =< {

오후.요청.헤더.추가({

열쇠: “Couchbase-Timestamp”,

가치: 날짜

});

}

accessKey과 secretKey가 정의되어 있으면 해시를 생성할 수 있습니다.

만약 (오후.환경.가지고 있다(“액세스 키”) && 오후.환경.가지고 있다(“비밀키”)) {

URL의 변수 바꾸기

상수 파싱된URL = 오후.변수.replaceIn(URL);

페이로드 생성

상수 페이로드 = [방법, 파싱된URL, 지금].가입하기(“n”);

콘솔.로그(“페이로드”, 페이로드);

해시 생성

상수 해시 = 해시생성(페이로드, 오후.환경.얻다(“비밀키”))

// 토큰을 환경 변수에 저장합니다.

토큰설정(오후.환경.얻다(“액세스 키”), 해시);

// 요청에 타임스탬프 헤더 추가

타임스탬프 헤더 설정(지금);

}

오후.환경.설정(“어제”, 어제.JSON으로 변환());

오후.환경.설정(“지금”, 새로운 날짜().JSON으로 변환());

이 시점에서 쿼리를 실행할 준비가 되었습니다. 다음으로 몇 가지 실행 방법을 살펴보겠습니다. 공개 API 쿼리.

쿼리 실행

첫 번째 예시로, 다음을 실행해 보겠습니다. 사용자 목록 사용자 폴더를 호출하세요.

이 쿼리를 실행하면 시스템에 사용자가 있음에도 불구하고 응답이 비어 있는 것을 확인할 수 있습니다. 이는 쿼리 매개변수에 잘못된 기본값이 할당되었기 때문입니다.

다음 쿼리 파라미터를 수정해야 합니다: 페이지 그리고 페이지당 항목 수. 다음 예시에서, 나는 바꿀 것이다 페이지 1과 그리고 페이지당 항목 수 API에서 예상된 결과를 얻으려면 100으로 설정하세요.

그게 다입니다! 이제 Couchbase Capella의 공개 API를 탐색할 준비가 되었습니다. 프로젝트에서 이를 활용할 수 있는 흥미로운 방법을 찾으시기를 바랍니다.

왜 카우치베이스인가

산업별

사용 사례별

자원 센터

Couchbase를 기반으로 구축하기

우리는 누구인가?

파트너

Couchbase Capella 공개 API와 Postman 사용하기

프로미드에서 에지 AI까지 — 해커톤 참가자들이 1시간 미만에 모바일 앱을 만들다

Couchbase Server 8.5 프라이빗 프리뷰: 실행하기 쉬워지고 쿼리하기 더 스마트해졌습니다.

AI 데이터 플레인을 한층 강화했습니다: 관리할 게 줄었고, 에이전트의 ROI는 더 높아졌습니다

프로미드에서 실행 중인 앱으로: Couchbase Mobile용 에이전트 스킬 소개

엣지 AI란 무엇인가? 엣지 컴퓨팅의 예시와 이점

데이터베이스의 확장성을 과거의 일로 남겨두세요