스티비 API

소개

이 문서는 스티비 API의 인증 방식, 공통 요청 규칙, 오류 응답 형식과 각 API의 요청 및 응답 구조를 설명합니다.

요금제별 권한

• 구독자: 구독자 추가, 수정 등 구독자 관리를 자동화해 고객 DB와 연동할 수 있습니다.
• 이메일, 그룹: 이메일 생성, 편집, 발송, 그룹 관리를 자동화할 수 있습니다.
• 주소록, 발신자 주소: 주소록 관리와 발신자 이메일 주소 관리를 자동화할 수 있습니다.

요청 속도 제한

요금제별 권한, 요청 속도 제한은 각 API 항목별 페이지의 제목 위에 표시되어있습니다.

Base URL

모든 API 요청은 다음 Base URL을 기준으로 합니다:
https://api.stibee.com/v2

이메일 목록 조회 예시

GET https://api.stibee.com/v2/emails

인증

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

2025년 1월 21일 이후에 생성된 API 키로만 인증할 수 있습니다. AccessToken 헤더가 없거나 유효하지 않으면 Errors.Authorization.NoToken (message: "존재하지 않는 토큰 입니다.") 오류가 반환됩니다.

인증 확인

/auth-check는 발급된 API 키를 사용해 인증이 정상적으로 되는지 확인할 수 있는 테스트용 요청입니다.

GET /auth-check
AccessToken: YOUR_API_KEY

오류 응답

요청이 성공하면 200 OK가 반환됩니다. 요청 값이 잘못되었거나 처리할 수 없는 경우 400 Bad Request가 반환됩니다. 5XX 오류가 반환되면 일시적인 시스템 오류일 수 있습니다. 이 경우 재시도 처리를 권장합니다.

오류 응답 형식은 다음과 같습니다.

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

요청 형식

쿼리스트링을 제외한 모든 요청 본문은 application/json 형식이며, 인코딩은 UTF-8입니다.