스티비 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: abcdefg1234

오류 응답

정상적인 상황에서는 200 OK 또는 400 Bad Request가 반환됩니다.
5XX 에러는 시스템 장애로 간주되며, 재시도 등의 처리가 필요합니다.
API 요청 시 실패에 대한 400 코드 오류의 형태는 다음과 같습니다.

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

포맷

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