Skip to content

API 개요

이 참조 문서에서는 일반적인 용어와 REST API 키 개요, 권한, 보안 유지 방법 등 API 기본 사항을 다룹니다.

Braze REST API 컬렉션

API 정의

다음은 Braze REST API 설명서에서 볼 수 있는 용어에 대한 개요입니다.

엔드포인트

Braze는 대시보드 및 REST 엔드포인트에 대한 다양한 인스턴스를 관리합니다. 계정이 프로비저닝되면 다음 URL 중 하나에 로그인하게 됩니다. 프로비저닝된 인스턴스에 따라 올바른 REST 엔드포인트를 사용하세요. 확실하지 않은 경우 [지원 티켓]] [지원] ]을 열거나 다음 표를 사용하여 사용 중인 대시보드의 URL을 올바른 REST 엔드포인트에 일치시키세요.

API 제한

대부분의 API에서 Braze의 기본 사용량 제한은 시간당 250,000건의 요청입니다. 그러나 특정 요청 유형에는 고객 기반 전체의 대용량 데이터를 더 잘 처리하기 위해 자체 사용량 제한이 적용됩니다. 자세한 내용은 API 사용량 제한을 참조하세요.

사용자 ID

  • 외부 사용자 ID: external_id는 데이터를 제출하는 대상을 위한 고유한 사용자 식별자 역할을 합니다. 동일한 사용자에 대해 여러 프로필을 생성하지 않으려면 이 식별자가 Braze SDK에서 설정한 식별자와 동일해야 합니다.
  • Braze 사용자 ID: braze_id는 Braze에서 설정한 고유한 사용자 식별자로 사용됩니다. 이 식별자는 external_ids 외에도 REST API를 통해 사용자를 삭제하는 데 사용할 수 있습니다.

자세한 내용은 플랫폼에 따라 iOS, Android 및 웹에 대한 다음 도움말 문서를 참조하세요.

REST API 키 정보

REST 애플리케이션 프로그래밍 인터페이스 키 (REST API 키)는 API 호출을 인증하고 호출 애플리케이션 또는 사용자를 식별하기 위해 API에 전달되는 고유 코드입니다. API 액세스는 회사의 REST API 엔드포인트에 대한 HTTPS 웹 요청을 사용하여 수행됩니다. Braze에서는 REST API 키를 앱 식별자 키와 함께 사용하여 데이터를 추적, 액세스, 전송, 내보내기 및 분석을 통해 사용자와 당사 측 모두에서 모든 것이 원활하게 실행되도록 합니다.

Braze에서는 워크스페이스와 API 키가 함께 사용됩니다. 워크스페이스는 여러 플랫폼에서 동일한 애플리케이션의 버전을 수용하도록 설계되었습니다. 또한 많은 고객이 워크스페이스를 사용하여 동일한 플랫폼에서 애플리케이션의 무료 버전과 프리미엄 버전을 포함합니다. 아시다시피 이러한 워크스페이스도 REST API를 사용하며 자체 REST API 키를 가지고 있습니다. 이 키는 API의 특정 엔드포인트에 대한 액세스를 포함하도록 개별적으로 범위를 지정할 수 있습니다. 각 API 호출에는 엔드포인트 히트에 대한 액세스 권한이 있는 키가 포함되어야 합니다.

REST API 키와 워크스페이스 API 키를 모두 api_key라고 합니다. api_key는 각 요청에 요청 헤더로 포함되며 REST API를 사용할 수 있는 인증 키 역할을 합니다. 이러한 REST API는 사용자 추적, 메시지 전송, 사용자 데이터 내보내기 등에 사용됩니다. 새 REST API 키를 생성할 때는 특정 엔드포인트에 대한 액세스 권한을 부여해야 합니다. API 키에 특정 권한을 할당하면 API 키가 인증할 수 있는 호출을 정확히 제한할 수 있습니다.

![REST API 키 패널의 API 키 탭에 있습니다.][27]

REST API 키 만들기

새 REST API 키를 만들려면 다음과 같이 하세요:

  1. 설정 > API 및 식별자로 이동합니다.

2. API 키 생성을 선택합니다. 3. 한 눈에 식별할 수 있도록 새 키에 이름을 지정합니다. 4. 새 키의 허용 목록에 있는 IP 주소 및 서브넷을 지정합니다. 5. 새 키에 연결할 권한을 선택합니다.

REST API 키 권한

API 키 권한은 사용자 또는 그룹에 할당하여 특정 API 호출에 대한 액세스를 제한할 수 있는 권한입니다. API 키 권한 목록을 보려면 설정 > API 및 식별자로 이동하여 API 키를 선택합니다.

REST API 키 관리

설정 > API 및 식별자 > API 키 탭에서 기존 REST API 키에 대한 세부 정보를 보거나 삭제할 수 있습니다. REST API 키는 생성된 후에는 편집할 수 없습니다.

API 키 탭에는 각 키에 대한 다음 정보가 포함되어 있습니다:

API 키의 세부 정보를 보려면 키 위로 마우스를 가져가 보기를 선택합니다. 여기에는 이 키가 가진 모든 권한, 화이트리스트 IP(있는 경우), 이 키가 Braze IP 화이트리스트에 옵트인된 경우 등이 포함됩니다.

![][30]

사용자를 삭제할 때 사용자가 생성한 관련 API 키는 삭제되지 않는다는 점에 유의하세요. 키를 삭제하려면 키 위로 마우스를 가져가 삭제를 선택합니다.

![][29]{: style=”max-width:30%;”}

REST API 키 보안

API 키는 API 호출을 인증하는 데 사용됩니다. 새 REST API 키를 생성할 때는 특정 엔드포인트에 대한 액세스 권한을 부여해야 합니다. API 키에 특정 권한을 할당하면 API 키가 인증할 수 있는 호출을 정확히 제한할 수 있습니다.

REST API 키는 잠재적으로 민감한 REST API 엔드포인트에 대한 액세스를 허용하므로 이러한 키를 보호하고 신뢰할 수 있는 파트너와만 공유하세요. 키가 공개적으로 노출되어서는 안 됩니다. 예를 들어 이 키를 사용하여 웹사이트에서 AJAX를 호출하거나 다른 공개 방식으로 노출하지 마세요.

좋은 보안 관행은 사용자에게 작업을 완료하는 데 필요한 만큼의 액세스 권한만 할당하는 것입니다. 이 원칙은 각 키에 권한을 할당하여 API 키에도 적용할 수 있습니다. 이러한 권한을 통해 계정의 다양한 영역에 대한 보안과 제어를 강화할 수 있습니다.

실수로 키가 노출된 경우 개발자 콘솔에서 키를 삭제할 수 있습니다. 이 프로세스에 대한 도움이 필요하면 [지원 티켓]] [지원]]을 열어주세요.

API IP 허용 목록

보안을 강화하기 위해 특정 REST API 키에 대해 REST API 요청을 보내도록 허용할 IP 주소와 서브넷 목록을 지정할 수 있습니다. 이를 허용 목록 또는 화이트리스트라고 합니다. 특정 IP 주소 또는 서브넷을 허용하려면 새 REST API 키를 생성할 때 화이트리스트 IP 섹션에 추가하세요.

API 키를 생성할 때 IP를 허용 목록에 추가하는 옵션입니다.

지정하지 않으면 모든 IP 주소에서 요청을 보낼 수 있습니다.

추가 리소스

Ruby 클라이언트 라이브러리

Ruby를 사용하여 Braze를 구현하는 경우 Ruby 클라이언트 라이브러리를 사용하여 데이터 가져오기 시간을 단축할 수 있습니다. 클라이언트 라이브러리는 한 프로그래밍 언어 (이 경우에는 Ruby)에 특화된 코드 모음으로, API를 더 쉽게 사용할 수 있게 해줍니다.

루비 클라이언트 라이브러리는 사용자 엔드포인트를 지원합니다.

[support]: /docs/ko/braze_support/ [28]: /docs/ko/assets/img_archive/create-new-key.png?c946be26e03a7d399c1ee05bbbf811d9 [29]: /docs/ko/assets/img_archive/api-key-options.png?8ed31146d679baf4a4a5974ad8c17923 [27]: /docs/ko/assets/img_archive/rest-api-key.png?842dc6972dfb265bb1753e6f4f1b138f [30]: /docs/ko/assets/img_archive/view-api-key.png?3d0fa48c855271f5f64687315bc1c955

Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!