Klaviyo API 시작하기
학습 내용
API 호출의 기본 개념과 Klaviyo API가 비즈니스에 어떤 이점을 제공할 수 있는지 알아보세요. 이 가이드에서는 REST API, HTTP 메서드, 개발자 도구를 알아보고 Klaviyo API를 테스트할 수 있도록 준비해요. 첫 API 호출은 처음부터 끝까지 10분이면 완료할 수 있어요. 이미 API 호출에 익숙하고 API를 테스트할 준비가 되었다면 Postman 컬렉션을 사용하는 방법에 대한 가이드를 따라 주세요.
이 가이드 전반에서 새로운 기술 용어가 소개되면 용어집으로 연결되는 링크를 제공할게요. 가이드에서 어떤 단어의 의미가 확실하지 않다면 기술 용어 용어집을 확인해 보세요.
REST API란 무엇인가요?
REST API는 Representational State Transfer와 Application Programming Interface를 의미하는 약어입니다. 이 용어는 한 소프트웨어가 다른 소프트웨어와 통신하고 서로 간에 정보를 주고받을 수 있게 해주는 구조화된 요청으로 더 간단히 이해할 수 있어요. Klaviyo API를 호출하면 서버에 요청을 보내고 응답을 받게 돼요. 응답에는 상태 코드가 포함되며, 엔드포인트가 데이터를 반환하는 경우 JSON(JavaScript Object Notation) 형식의 본문이 포함돼요. 성공한 요청 중에는 응답 본문이 없는 경우도 있어요.
더 쉽게 말해, REST API를 사용하면 Klaviyo에 저장된 데이터를 요청하고, 사람이 읽을 수 있고 컴퓨터도 읽을 수 있는 형식으로 해당 데이터를 돌려받을 수 있어요.
데이터를 검색하기 위한 GET request는 다음 단계를 따르세요:
- 인터넷을 통해 API로 구조화된 데이터 요청을 보내세요. 요청은 HTTP를 통해 전송되며, HTTP는 인터넷이 대부분 이를 기반으로 구축된 기본 네트워크 요청 유형이에요.
- API는 요청을 수신하고 처리한 다음, Klaviyo 데이터베이스에서 요청된 정보를 가져옵니다.
- 그러면 API는 JSON 구조화 형식을 사용해 클라이언트 애플리케이션에 응답합니다.
- 클라이언트 애플리케이션에서 JSON 응답을 받게 됩니다.
이 지식은 데이터 전송이 어떻게 작동하는지 이해하는 데 도움이 되지만, API 호출을 시작하고 Klaviyo API에서 제공하는 가치를 얻는 데 꼭 필요하진 않아요. 다음 섹션에서는 기본 사항을 설명하고, 링크된 Postman 가이드에서는 첫 API 호출을 단계별로 안내해요.
HTTP 방식
HTTP 메서드는 요청을 보내는 데 사용하는 “동사”예요. 이 가이드에서는 2가지 HTTP 메서드 인 GET과 POST를 다룰게요.
여기서는 사용하지 않지만, 대부분의 REST API는 PUT, PATCH, DELETE 같은 추가 HTTP 메서드도 지원한다는 점을 알아두면 좋아요.
GET
GET 요청은 “읽기” 요청으로 이해하면 가장 쉬워요. GET 요청은 API 엔드포인트에서 정보를 가져와 JSON 형식의 응답으로 반환해요. 이 요청은 데이터 읽기만 허용하므로, 이 방법으로는 데이터를 수정하거나 덮어쓸 수 없어 가장 안전한 요청 유형이에요.
POST
POST 요청은 간단히 “쓰기” 요청으로 이해할 수 있어요. POST를 사용하면 새 리소스를 생성하거나 추가할 수 있어요. 예를 들어, Lists API에 POST 요청을 보내면 계정에 새 리스트를 만들 수 있고, GET 요청을 사용하면 리스트를 페이지별로 가져올 수 있어요. 더 이상 페이지가 없을 때까지 각 응답에서 다음 페이지 링크를 따라가세요.
성공 응답은 해당 엔드포인트의 참조 문서를 확인해 주세요. 리스트를 생성하면 새 리스트의 데이터와 함께 201(Created)이 반환돼요. 이벤트 생성과 같은 일부 POST 요청은 응답 본문 없이 202(Accepted)를 반환해요. 202 응답은 처리하기 위해 요청이 수락되었음을 의미해요. 처리가 완료되었는지는 확인해 주지 않아요.
필요한 도구
API는 워크플로우에 큰 유연성을 제공하고, 원하는 결과를 얻기 위해 특정 클라이언트 애플리케이션이나 언어 라이브러리를 사용할 필요가 없어요. API 호출은 HTTP 요청을 사용해 이루어지기 때문에, 거의 모든 프로그래밍 언어에서 기본 기능으로 또는 널리 사용되는 언어 라이브러리를 통해 이런 유형의 요청을 전송할 수 있어요. 또한 사용하는 컴퓨터와 운영 체제에 따라 Apple의 Terminal 또는 Windows Terminal 같은 기본 애플리케이션을 사용해 컴퓨터에서 API 호출을 수행할 수 있어요. 하지만 이러한 애플리케이션을 사용하려면 명령줄 인터페이스에 대한 사전 지식이 필요해요.
Postman이라는 무료 웹 및 데스크톱 애플리케이션을 사용해요. Postman에는 엔드포인트, 매개변수, 인증을 유용한 사용자 인터페이스에 입력해 API 요청을 설정하고 전송하기 쉽게 해주는 다양한 기능이 있어요.
Klaviyo API 테스트
실험을 위해 Klaviyo 테스트 계정을 사용해 보세요. POST 요청은 Postman에서 보내더라도, 사용자 인증 정보와 연결된 계정의 데이터를 변경할 수 있어요.
비공개 API 키를 사용하는 요청의 경우, 테스트하려는 엔드포인트에 필요한 권한이 있는 키를 생성하세요. 예를 들어 리스트를 가져오려면 lists:read가 필요하고, 리스트를 생성하려면 lists:write가 필요해요. 비공개 API 키는 안전하게 보관하고 브라우저 코드에 절대 노출하지 마세요.
Klaviyo의 API는 다른 플랫폼이나 서버에서 Klaviyo 계정으로 데이터를 전송하거나, Klaviyo 계정 내의 정보를 조회하는 데 유용해요. 이제 API가 작동하는 방식을 이해했으니, 비즈니스 사용 사례에 맞게 Klaviyo의 API를 테스트하는 작업을 시작할 수 있어요. Klaviyo에서 사용 가능한 API의 전체 목록을 확인하려면 API 참조 문서를 확인해 주세요. Postman 컬렉션 사용 방법 가이드 를 따라 첫 Klaviyo API 호출을 만들어 보세요.
추가 자료
개발자 포털 리소스
Klaviyo의 개발자 포털 에는 API를 최대한 활용할 수 있도록 도와주는 API 가이드 및 참조 문서가 포함되어 있어요. 시작하려면 아래 리소스를 확인하세요:
Klaviyo 개발자 교육 코스
Klaviyo 아카데미 에서는 Klaviyo API로 빌드를 시작하는 데 도움이 되는 개발자 교육 코스를 제공해요. 아래의 교육 코스를 확인해 보세요: