콘텐츠로 건너뛰기

Postman 및 샘플 요청

Braze를 사용하면 Postman 컬렉션을 통해 모든 엔드포인트에 대한 샘플 API 요청을 생성할 수 있습니다. 이 참조 문서에서는 Braze Postman 컬렉션이 무엇인지, 컬렉션을 설정하고 사용하는 방법, 요청을 편집하고 보내는 방법을 다룹니다.

Postman이란 무엇인가요?

Postman은 API 요청을 빌드하고 테스트할 수 있는 무료 시각적 편집 도구입니다. 다른 방법(예: cURL 사용)과 비교해 Postman을 사용하면 API 요청을 편집하고 헤더 정보를 확인하는 등 다양한 작업을 할 수 있습니다. 컬렉션(미리 만들어진 샘플 API 요청 라이브러리)을 저장할 수도 있습니다. Braze는 REST API 설정을 빠르게 진행할 수 있도록 모든 엔드포인트에 대해 미리 만들어진 예제가 포함된 컬렉션을 제공합니다.

시작하려면 Postman 설명서에서 Run in Postman을 클릭해 Postman 컬렉션을 확인하거나 다운로드하세요.

Braze Postman 컬렉션 사용

Postman 계정이 있는 경우(Postman 웹사이트에서 macOS, Windows, Linux 버전을 다운로드할 수 있습니다), 주황색 Run in Postman 버튼을 클릭하여 사용 중인 Postman 앱에서 Braze Postman 설명서를 열 수 있습니다. 그런 다음 환경을 만들거나 Braze REST API 환경을 템플릿으로 사용하고, 제공되는 POST 및 GET 요청을 필요에 맞게 편집할 수 있습니다.

Postman 환경 설정

Braze Postman 컬렉션은 템플릿 변수 {{instance_url}}를 사용하여 Braze 인스턴스의 REST API URL을 미리 만들어진 요청에 대입하고, {{api_key}} 변수를 사용하여 API 키를 대입합니다. 컬렉션의 모든 요청을 수동으로 편집하는 대신 Postman 환경에서 이 변수를 설정할 수 있습니다. 드롭다운에서 템플릿 환경(Braze REST API Environment Template)을 선택하고 변수 값을 직접 사용하는 값으로 바꾸거나, 자체 환경을 설정할 수 있습니다.

자체 환경을 설정하려면 다음 단계를 수행합니다.

  1. Workspaces 탭에서 Environments를 선택합니다.
  2. + 더하기 버튼을 클릭하여 새 환경을 만듭니다.
  3. 환경 이름(예: “Braze API Requests”)을 지정하고, instance_url 및 api_key 키를 추가한 다음 Braze 인스턴스 및 Braze REST API 키에 해당하는 값을 입력합니다.
  4. Save를 클릭합니다.

Postman의 Braze REST API 환경에 API 키 및 인스턴스 URL 변수를 추가하는 화면

컬렉션의 미리 만들어진 요청 사용

환경을 구성한 후에는 컬렉션에 있는 미리 만들어진 요청을 템플릿으로 사용하여 새 API 요청을 작성할 수 있습니다. 미리 만들어진 요청을 사용하려면 Postman의 Collections 메뉴에서 해당 요청을 클릭합니다. 그러면 Postman 앱의 메인 창에서 요청이 새 탭으로 열립니다.

일반적으로 Braze API 엔드포인트가 허용하는 요청은 GET과 POST 두 가지 유형입니다. 엔드포인트가 사용하는 HTTP 메서드에 따라 미리 만들어진 요청을 편집하는 방법이 다릅니다.

POST 요청 편집

POST 요청을 편집할 때는 요청을 열고 요청 편집기의 Body 섹션으로 이동합니다. 가독성을 높이려면 raw 라디오 버튼을 선택하여 JSON 요청 본문의 형식을 지정합니다.

Postman에서 POST User Track 요청을 편집할 때 표시되는 Body 탭

GET 요청 편집

GET 요청을 편집할 때는 요청 URL에 전달되는 파라미터를 편집합니다. 이렇게 하려면 Params 탭을 선택하고 표시되는 필드에서 키-값 페어를 편집합니다.

Postman에서 GET Query List of Unsubscribed Email Addresses 요청을 편집할 때 표시되는 Params 탭

요청 보내기

API 요청이 준비되면 Send를 클릭합니다. 요청이 전송되고 요청 편집기 아래 섹션에 응답 데이터가 표시됩니다. 여기에서 Braze API가 반환한 원시 데이터를 확인하고, HTTP 응답 코드와 요청 처리에 걸린 시간을 확인하며, 헤더 정보를 볼 수 있습니다.

상태가 201 Created이고 응답 시간이 269밀리초인 POST 요청의 응답 본문 데이터 예시

New Stuff!