비공개 API 키를 생성하거나 복제하는 방법
비공개 API 키를 생성, 복제 또는 삭제하려면 소유자 또는 관리자여야 해요.
학습 내용
API 호출에 사용되는 고유 식별자인 비공개 API 키를 만들고, 범위를 정의하는 방법을 알아보세요.
비공개 API 키와 범위는 타사에서 액세스할 수 있는 항목을 제한하여 사용자와 고객의 데이터를 보호하는 데 도움이 돼요.
비공개 API 키 및 범위 정보
API 호출을 하면 한 소프트웨어가 다른 소프트웨어와 연결할 수 있어요. 이 연결을 통해 한 소프트웨어가 다른 소프트웨어에 정보를 요청하거나, 수정하거나, 추가할 수 있어요.
비공개 API 키는 이 요청에 올바른 권한이 있는지(즉, 권한이 있는 사용자, 계정 또는 프로그램에서 왔는지) 확인해요. 집 열쇠처럼 생각해 보세요. 본인과 가족은 들어올 수 있지만, 다른 사람들은 모두 막아 줘요.
비공개 API 키에 스코프를 포함하면 추가적인 인증 계층이 더해져 타사가 액세스할 수 있는 특정 요소가 제한돼요. 범위(scope)는 호텔 키와 비슷해서, 건물 전체가 아니라 특정 구역(예: 객실이나 헬스장)에만 접근할 수 있게 해줘요.
범위 유형
비공개 API 키를 만들 때는 범위를 선택해야 해요. 즉, 서드 파티가 다음 작업을 할 수 있게 할지 결정해야 해요.
- API 엔드포인트에 대한 액세스 권한이 없습니다.
- API 엔드포인트의 모든 데이터를 볼 수 있지만 변경할 수는 없어요(“읽기 전용”이라고도 해요).
- 해당 엔드포인트와 연결된 모든 항목을 생성, 삭제하고 기타 변경을 수행해요(“전체 액세스” 또는 “쓰기 액세스”라고도 해요).
예를 들어, 타사 소프트웨어에서 Klaviyo 리스트에 구독자를 추가 하려고 한다고 해볼게요. 이 경우 리스트, 프로필, 그리고 대량 구독 프로필에 대한 API 엔드포인트에 전체(쓰기) 액세스 권한이 있어야 해요. 하지만 타사에는 다른 어떤 엔드포인트에 대한 액세스도 필요하지 않아요.
개발자 포털에서 Klaviyo API에 대해 알아보고, 각 엔드포인트에서 사용 가능한 범위를 확인할 수 있어요.
시작하기 전에 알아야 할 것
다음 사항에 유의하세요:
- 비공개 API 키를 만든 후에는 다음을 할 수 없어요:
- 비공개 API 키를 다시 확인합니다.
- 팁: 비공개 API 키는 안전하게 저장하고, 비밀번호 관리자 등에서 어떤 용도로 사용할지 메모해 두세요.
- 해당 범위를 추가하거나 편집하세요.
- 범위를 변경해야 하는 경우, 유일한 방법은 기존 비공개 API 키를 삭제한 다음 올바른 범위로 새로 만드는 거예요.
- 비공개 API 키를 다시 확인합니다.
- 비공개 API 키는 기본적으로 전체 액세스 권한이 있어요.
어떤 API 엔드포인트, 범위 또는 권한이 필요한지 확신이 서지 않으면 개발자에게 문의하거나 도움을 받기 위해 Klaviyo 파트너에게 문의해 주세요.
비공개 API 키 생성
비공개 API 키를 생성한 후에는 해당 키를 볼 수 없습니다. 대신 비공개 API 키를 비밀번호처럼 취급하여 신뢰할 수 있는 당사자와만 공유하고 볼트나 비밀번호 관리자와 같은 안전한 곳에 저장해야 합니다.
- 왼쪽 하단에서 조직 이름을 클릭합니다.
- 설정으로 이동합니다.
- Click API 키.
- 비공개 API 키 생성을 클릭하세요.
- API 키 이름을 지정하세요.
- API 키에 부여할 범위를 선택해 주세요:
- 읽기 전용
- 전체
- 사용자 정의
- 생성을 선택합니다.
이제 비공개 API 키를 공유하면 서드파티는 범위에서 정의한 정보에만 액세스할 수 있어요.
쿼리 사용
쿼리는 고급 시나리오에서 사용돼요. 쿼리 또는 사용 방법에 아직 익숙하지 않다면 개발자와 함께 진행하는 것이 좋아요.
포함
include 쿼리를 사용하려고 하면, 위에 나열된 형식에서 형식을 변경해야 한다는 점에 유의하세요.
예를 들어, 프로필 엔드포인트는 /api/profiles예요.
하지만 include 쿼리 매개 변수(/api/프로필?include=list)를 추가하면, 수행하는 API 호출 유형에 따라 list:read 또는 list:full access도 필요해요.
범위
scopes 매개변수를 사용하면 비공개 API 키에 필요한 액세스 범위가 무엇인지 자동으로 입력할 수 있는 URL 매개변수를 만들 수 있어요.
scopes 쿼리에는 미리 선택하려는 범위(scope)의 쉼표로 구분된 목록을 포함하세요.
예시 URL은 다음과 같아요:
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write
개발자 포털로 이동하여 이 쿼리에서 사용할 수 있는 범위를 확인하세요.
비공개 API 키 복제
비공개 API 키를 사용하면 복제를 통해 원래 키와 동일한 범위 및 권한을 가진 새 키를 만들 수 있어요.
참고:
- 복제하면 원래의 비공개 API 키와 동일한 키가 생성되지 않습니다.
- 복제된 API 키는 이름을 다시 지정할 수 없으며, 원래 키와 같은 이름을 사용해요.
비공개 API 키를 복제하려면 다음을 수행하세요:
- API 키 탭으로 이동합니다.
- 복제하려는 키 옆의 점 3개 메뉴를 클릭합니다.
- Clone > Clone을 선택하세요.
- 새 비공개 API 키를 복사하거나 다운로드한 다음 안전한 곳에 보관하세요.
- 더 이상 필요하지 않다면 이전 키를 삭제해 주세요.