How to Use Postman with Couchbase Capella Public API

중요 업데이트: V3 API는 곧 더 이상 사용되지 않으며 수명 종료일 이후에는 더 이상 업데이트나 지원을 제공하지 않습니다. 향상된 기능과 향상된 성능의 혜택을 누리시려면 새로운 V4 API로 전환하실 것을 강력히 권장합니다. 저희는 V4로 작업을 시작하는 방법에 대한 단계를 자세히 설명하는 종합 가이드 를 통해 최대한 원활하게 진행할 수 있습니다.

카우치베이스 카펠라는 관리자와 개발자가 다양한 프로그래밍 언어와 플랫폼을 사용하여 컨트롤 플레인과 통합하고 상호 작용할 수 있는 공용 API를 제공합니다.. RESTful API는 고객이 Couchbase Capella와 통합하여 다음과 같은 작업을 수행할 수 있도록 하기 위한 것입니다:

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

이 블로그 게시물에서는 다음을 활용하는 방법에 대해 설명합니다. Postman API 클라이언트 를 사용하여 REST 인터페이스를 통해 카우치베이스 카펠라 퍼블릭 API와 상호 작용할 수 있습니다.

이 튜토리얼에서는 Capella 공개 API v3를 사용합니다. API의 개선된 버전이 준비 중이며, 이 버전에는 몇 가지 획기적인 변경 사항이 있을 수 있습니다. 따라서 이 버전과의 이전 버전과의 호환성을 보장할 수 없으므로 프로덕션 배포에서 이 버전의 API를 사용하지 않는 것이 좋습니다. 하지만 API를 평가하고 새 버전의 공개 API에 추가되기를 바라는 기능에 대한 피드백을 보내주시기 바랍니다.

전제 조건

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

- 또한 공개 API를 사용하려면 액세스 키와 비밀 키를 만들어야 합니다. 키를 설정하는 방법에 대한 지침을 참조하세요. 여기.

새 Postman 환경 만들기

이 단계에서는 새로운 Postman 환경(Postman 요청에 사용할 수 있는 변수 집합)을 설정합니다. 카우치베이스 카펠라의 공개 API를 사용하려면 액세스 권한과 비밀키가 필요합니다.

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

- accessKey 액세스 키가 포함된
- 비밀키 비밀이 담긴

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

OpenAPI 정의 가져오기

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

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

인증 구성

카우치베이스 카펠라 퍼블릭 API는 무기명 토큰 인증 메커니즘을 사용하여 퍼블릭 API를 호출할 때마다 인증을 받아야 합니다. 모든 요청과 함께 보내야 하는 두 개의 헤더에 대한 자세한 내용은 다음 문서를 참조하세요. 공식 문서 를 보안 헤더에 추가합니다.

시작을 돕기 위해 액세스 및 비밀 키를 기반으로 필요한 헤더를 생성하는 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());

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

const URL = 오후.요청.URL.getPathWithQuery()

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

const 메서드 = 오후.요청.메서드;

// 타임스탬프 생성

const 지금 = new 날짜().getTime();

// 과거의 날짜 시간

const 어제 = new 날짜();

어제.setDate(어제.getDate() - 1);

// SHA-256 해시

const createHash = (페이로드, 비밀) => {

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

.toString(CryptoJS.enc.Base64);

}

// 베어러 토큰 생성

const setToken = (accessKey, 해시) => {

오후.환경.set("bearerToken", accessKey + ':' + 해시);

}

// 타임스탬프 헤더 생성

const 설정 타임스탬프 헤더 = (날짜) => {

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

키: "카우치베이스-타임스탬프",

값: 날짜

});

}

// 액세스키와 비밀키가 정의되어 있으면 해시를 생성할 수 있습니다.

만약 (오후.환경.has("accessKey") && 오후.환경.has("secretKey")) {

// URL에서 변수 바꾸기

const parsedURL = 오후.변수.replaceIn(URL);

// 페이로드 생성

const 페이로드 = [메서드, parsedURL, 지금].join("\n");

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

// 해시 생성

const 해시 = createHash(페이로드, 오후.환경.get("secretKey"))

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

setToken(오후.환경.get("accessKey"), 해시);

// 요청에 타임스탬프 헤더를 추가합니다.

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

}

오후.환경.set("어제", 어제.toJSON());

오후.환경.set("지금", new 날짜().toJSON());

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

쿼리 실행

첫 번째 예로, 다음과 같이 사용자 목록 사용자 폴더에서 호출합니다.

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

다음 쿼리 매개변수를 수정해야 합니다: 페이지 그리고 페이지당. 다음 예제에서는 페이지 를 1로 설정하고 페이지당 를 100으로 설정하면 API에서 예상 결과를 얻을 수 있습니다.

여기까지입니다! 이제 카우치베이스 카펠라의 퍼블릭 API를 알아볼 준비가 되셨습니다. 여러분의 프로젝트에서 흥미로운 사용 방법을 찾아보시기 바랍니다.

이스트반 오르반

이 문서 공유하기

Platform

Self-Managed

Services

Capabilities

Why Couchbase?

Migrate to Capella

By Use Case

By Industry

By Application Need

Popular Docs

By Developer Role

Quickstart

Resource Center

About

Partnerships

Our Services

Partners: Register a Deal

Ready to register a deal with Couchbase?

Marriott

카우치베이스 카펠라 퍼블릭 API로 포스트맨 사용

전제 조건

새 Postman 환경 만들기

OpenAPI 정의 가져오기

인증 구성

쿼리 실행

받은 편지함에서 카우치베이스 블로그 업데이트 받기

작성자

게시자 이스트반 오르반

댓글 남기기 응답 취소

카우치베이스 카펠라를 시작할 준비가 되셨나요?

구축 시작

카펠라 무료 사용

연락하기