Buzzley
무료로 써 보기
API 키:
이 문서는 영어판이 기준이에요. 이 번역은 편의를 위해 제공되며, 최신 내용이 모두 반영되지 않았을 수 있어요.

API 문서

Buzzley REST API로 연동 기능을 만들어 보세요. 리소스 그룹 14개, 엔드포인트 49개를 제공해요.

인증

모든 API 요청은 Bearer 방식으로 Authorization 헤더에 API 키를 담아야 해요. API 키는 API 키 페이지에서 만들고 관리할 수 있어요.

curl https://api.buzzley.app/api/v1/reminders \
  -H "Authorization: Bearer bzl_your_api_key_here"

기본 URL

모든 엔드포인트는 다음 주소를 기준으로 해요.

https://api.buzzley.app/api/v1

요청 한도

계정마다 분당 60회, 하루 10,000회까지 요청할 수 있으며, 이 한도는 계정의 모든 API 키가 함께 사용해요. 모든 요청의 응답에는 다음 헤더가 포함돼요.

헤더설명
X-RateLimit-Limit분당 최대 요청 수
X-RateLimit-Remaining현재 구간에 남은 요청 수
X-RateLimit-Reset요청 한도가 초기화되기까지 남은 시간(초)

한도를 넘으면 retry_after 필드가 담긴 429 응답이 반환돼요.

응답 형식

모든 응답은 JSON이에요. 성공한 응답은 페이로드를 data 필드에 담아요. 오류 응답에는 기계가 읽을 수 있는 code와 사람이 읽을 수 있는 message가 담긴 error 객체가 포함돼요.

// Success
{
  "data": { ... }
}

// Error
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "title is required"
  }
}

오류 코드

상태코드설명
400INVALID_REQUEST요청 본문이나 매개변수가 올바르지 않아요
401UNAUTHORIZEDAPI 키가 없거나 유효하지 않아요
403FORBIDDENAPI 키에 이 작업을 할 권한이 없어요
404NOT_FOUND요청한 리소스가 없어요
409CONFLICT리소스가 이미 있거나 상태가 충돌해요
429RATE_LIMITED요청이 너무 많아요. 지정된 시간이 지난 뒤 다시 시도하세요
500INTERNAL_ERROR예기치 않은 서버 오류가 발생했어요

엔드포인트 레퍼런스

Ping엔드포인트 1개

API 키엔드포인트 1개

API 키로는 키를 나열할 수 있지만, 키를 만들거나 폐기하거나 계정을 삭제할 수는 없어요. API 키로 이런 요청을 보내면 403이 반환돼요. 키는 로그인한 상태에서 API 키 페이지에서 만들고 폐기하세요.

리마인더엔드포인트 7개

인스턴스엔드포인트 4개

인스턴스는 반복 리마인더의 개별 회차를 나타내요.

카테고리엔드포인트 4개

템플릿엔드포인트 6개

다시 알림 프리셋엔드포인트 4개

설정엔드포인트 2개

그룹엔드포인트 8개

모든 계정은 하나의 그룹(가족, 팀 또는 개인)에 속해요. 기기 한도는 그룹 단위로 적용돼요. 소유자 전용 작업은 API 키의 소유자가 그룹 소유자여야 해요.

기기엔드포인트 2개

프로필엔드포인트 1개

통계엔드포인트 1개

구독엔드포인트 1개