스티비 API

스티비에서 제공하는 API에 대한 요청 및 응답 방법을 확인할 수 있는 문서입니다.
(기존 API 문서: https://api.stibee.com/docs/)

• 구독자: 구독자 추가, 업데이트 등 구독자 관리를 자동화해 내 고객 DB와 연동할 수 있습니다.
  
• 이메일, 그룹: 이메일 발송, 관리를 자동화해 스티비에 로그인하지 않고 이메일을 만들고 발송할 수 있습니다.
• 주소록, 발신자 주소: 주소록 관리와 발신자 이메일 주소 관리를 자동화해 스티비에 로그인하지 않고 주소록을 만들고 발신자 주소를 추가할 수 있습니다.

모든 API 요청의 base URL은 https://api.stibee.com/v2 입니다.

이메일 목록 조회 예시
GET https://api.stibee.com/v2/emails

모든 API 요청은 인증을 위해 AccessToken 헤더를 필요로 합니다. AccessToken은 스티비 서비스의 [워크스페이스 설정] > [API 키]에서 생성할 수 있습니다. (스티비 도움말> 주소록 API 사용하기 > API 키 만들기)

GET /emails
AccessToken: abcdefg1234

서버가 정상적으로 운영되는 상황에서는 200 OK와 400 Bad Request만 응답됩니다. 이외의 5XX 응답코드에 대해서는 장애 상황으로 인지하여 재시도 등의 처리를 해야합니다. API 요청 시 실패에 대한 400 코드 오류의 형태는 다음과 같습니다.

{
  "code":"Errors.Data.InvalidRequest",
  "httpStatusCode":400,
  "message":"잘못된 요청입니다."
}

쿼리 스트링으로 요청되는 값을 제외한 모든 본문 요청은 JSON 타입이며 인코딩은 UTF-8입니다.