비공개 API 키를 만들거나 복제하는 방법

예상 4 읽은 시간(분)

업데이트 2024년 12월 6일 오후 6:54 EST

비공개 API 키를 생성, 복제 또는 삭제하려면 소유자 또는 관리자 권한이 있어야 합니다.

API 호출에 사용되는 고유 식별자인 비공개 API 키를 만들고 범위를 정의하는 방법을 알아보세요.

비공개 API 키와 범위는 모두 제3자가 액세스할 수 있는 항목을 제한하여 회원님과 회원님의 고객 데이터를 보호하는 데 도움이 됩니다.

API를 호출하면 한 소프트웨어가 다른 소프트웨어에 연결할 수 있습니다. 이 연결을 통해 소프트웨어는 다른 소프트웨어에 정보를 요청, 편집 또는 추가할 수 있습니다.

비공개 API 키는 이 요청에 올바른 권한이 있는지(즉, 권한이 부여된 사용자, 계정 또는 프로그램에서 온 요청인지) 확인합니다. 집 열쇠처럼 본인과 가족은 출입할 수 있지만 다른 사람은 출입할 수 없도록 하는 열쇠라고 생각하면 됩니다.

비공개 API 키에 대한 범위를 포함하면 인증 계층이 하나 더 추가되어 제3자가 액세스할 수 있는 특정 요소를 제한합니다. 범위는 호텔 키와 유사하며, 건물 전체가 아닌 특정 구역(예: 객실 또는 체육관)에만 액세스할 수 있습니다.

범위 유형

비공개 API 키를 만들 때는 범위를 선택해야 합니다. 즉, 제3자를 허용할지 여부를 결정해야 합니다:

API 엔드포인트에 대한 액세스 권한이 없습니다.
API 엔드포인트의 모든 데이터를 볼 수 있지만 변경할 수는 없습니다("읽기 전용"이라고도 함).
해당 엔드포인트와 관련된 모든 항목('전체 액세스' 또는 '쓰기 액세스'라고도 함)을 만들고, 삭제하고, 기타 변경을 수행합니다.

예를 들어 타사 소프트웨어의 Klaviyo 리스트에 구독자를 추가하려고 한다고 가정해 보겠습니다. 이 경우 리스트, 프로필 및 대량 구독 프로필에 대한 API 엔드포인트에 대한 전체(쓰기) 액세스 권한이 있어야 합니다. 그러나 제3자는 다른 엔드포인트에 액세스할 필요가 없습니다.

개발자 포털에서 Klaviyo의 API에 대해 알아보고 각 엔드포인트에 대해 사용 가능한 범위를 확인할 수 있습니다.

시작하기 전 안내 사항

다음 사항에 유의하세요:

비공개 API 키를 생성한 후에는 사용할 수 없습니다:
- 비공개 API 키를 다시 확인합니다.
  - 팁: 비공개 API 키를 안전하게 저장하고 비밀번호 관리자 등에 사용 용도를 기록해 두세요.
- 범위를 추가하거나 편집합니다.
  - 범위를 변경해야 하는 경우 유일한 옵션은 원래 비공개 API 키를 삭제한 다음 올바른 범위로 새 키를 만드는 것입니다.
비공개 API 키에는 기본적으로 전체 액세스 권한이 있습니다.

어떤 API 엔드포인트, 범위 또는 권한이 필요한지 잘 모르겠다면 개발자에게 문의하거나 Klaviyo 파트너에게 도움을 요청하세요.

비공개 API 키 만들기

비공개 API 키를 생성한 후에는 해당 키를 볼 수 없습니다. 대신 개인 API 키를 비밀번호처럼 취급하여 신뢰할 수 있는 당사자와만 공유하고 볼트나 비밀번호 관리자와 같은 안전한 곳에 저장해야 합니다.