API 사용하기
Last updated
Last updated
💬 이 내용은 스탠다드, 프로, 엔터프라이즈 요금제에 해당하는 도움말입니다.
API키 생성부터 사용할 수 있는 연동 종류까지 스티비에서 제공하는 API를 사용하기 위해 기본적으로 알아야 하는 내용에 대해 알아봅니다.
API에 대한 요청 및 응답 방법은 스티비 API 문서에서 확인하고 테스트할 수 있습니다.
스티비에서 제공하는 API는 크게 '이메일'과 '주소록' 두 가지로 나뉩니다.
이메일 API: 이메일을 생성하거나 콘텐츠를 수정하고 발송할 수 있으며, 발송한 이메일의 통계를 조회할 수 있습니다.
주소록 API: 주소록을 생성하거나 정보를 수정할 수 있고 주소록에 구독자를 추가하거나 정보를 수정할 수 있습니다. 주소록에 구독자를 나눠서 관리할 수 있는 [그룹]을 만들거나 수정할 수 있고 주소록에 발신자 이메일 주소를 추가하거나 삭제할 수 있습니다.
API를 사용하기 위해서는 API 키를 만들어야 합니다. API는 워크스페이스 단위로 관리되므로 [워크스페이스 이름 → 워크스페이스 설정 → API 키]에서 [+새로 만들기]를 눌러 API 키를 생성할 수 있습니다.
[+새로 만들기]를 클릭해서 API 키를 생성한 뒤, [복사하기]를 누르면 API 키를 복사할 수 있습니다. 이 키는 API 요청 시 토큰으로 사용됩니다. API 키는 최대 10개까지 생성할 수 있습니다.
*주의: API 키가 노출되면 워크스페이스 보안에 치명적인 문제가 생길 수 있습니다. API 키 노출이 의심된다면 의심되는 키를 비활성화하거나 삭제한 뒤, 새로운 키를 만들어서 사용해 주세요.
API 요청을 보낼 때 어떤 이메일, 주소록, 그룹 등에 대한 요청인지 구체적으로 지정해야 합니다. 각 이메일, 주소록, 그룹은 고유의 ID 값을 가지고 있고 이 ID는 브라우저의 URL에서 확인할 수 있습니다.
emailId는 이메일에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.
이메일 목록에서 ID를 확인하고 싶은 이메일의 이름을 클릭하여 편집 화면 또는 [이메일 대시보드]로 이동
브라우저에 표시되는 URL에서 'email' 뒤의 숫자를 확인(예: https://stibee.com/email/123456/... 일 때 emailid는 email 뒤에 있는 123456)
listId는 주소록에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.
주소록 목록에서 주소록 이름을 클릭하여 [주소록 대시보드]로 이동
브라우저에 표시되는 URL에서 'lists' 뒤의 숫자를 확인 (예: https://stibee.com/lists/123456/... 일 때 listid는 lists 뒤에 있는 123456)
groupId는 그룹에 할당된 고유의 아이디입니다. 아래 방법으로 확인할 수 있습니다.
주소록 목록에서 주소록 이름을 클릭하여 [주소록 대시보드]로 이동
[그룹]을 클릭하여 그룹 목록으로 이동
그룹 이름을 클릭하여 그룹 필터링이 적용된 구독자 목록으로 이동
브라우저에 표시되는 URL에서 'S' 뒤의 숫자를 확인(예: https://stibee.com/lists/123456/subscribers/S/789012 일 때 groupId는 S 뒤에 있는 789012)
API키를 만들고 이메일, 주소록, 그룹의 아이디를 확인하는 방법까지 알았다면 API 연동을 위한 기본적인 준비는 마무리 된 상황입니다. 지금부터는 스티비 API 문서를 참고해 원하는 기능을 구현하여 직접 사용하면 됩니다. API 문서에서는 요청에 대한 응답을 테스트 해볼 수 있고 여러 언어별 구현 예제도 확인할 수 있습니다. API를 사용해 스티비의 더 확장된 기능을 경험해보세요.
