개요

시작하기

Blitz Rocket API는 표준 HTTP 메서드를 사용하고 JSON 응답을 반환하는 RESTful API입니다. 모든 엔드포인트는 https://blitzrocket.com/api/v1를 통해 접근할 수 있습니다.

사전 준비 사항

API 호출을 하기 전에 다음이 필요합니다:

1. Blitz Rocket 계정 — 아직 없다면 blitzrocket.com에서 가입하세요
2. 팀 — Blitz Rocket 대시보드에서 팀을 생성하거나 가입하세요
3. API 키 — 팀 설정 페이지에서 생성하세요

API 키 유형

Blitz Rocket은 두 가지 유형의 API 키를 제공합니다:

요청하기

모든 요청에는 API 키가 포함되어야 합니다. 헤더 또는 쿼리 파라미터로 전달할 수 있습니다:

curl -X GET https://blitzrocket.com/api/v1/contests \
  -H "x-api-key: your_api_key_here"

curl -X GET "https://blitzrocket.com/api/v1/contests" \
  -H "x-api-key: your_api_key_here"

CORS 지원

모든 API v1 엔드포인트는 교차 출처 리소스 공유(CORS)를 지원하여 브라우저 기반 애플리케이션에서 요청할 수 있습니다. 모든 응답에 다음 헤더가 설정됩니다:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, x-api-key

콘텐츠 타입

POST 및 PUT 요청의 경우, 요청 본문을 JSON으로 보내고 Content-Type: application/json 헤더를 포함하세요.

페이지네이션

목록을 반환하는 엔드포인트는 다음 쿼리 파라미터로 페이지네이션을 지원합니다:

페이지네이션된 응답에는 pagination 객체가 포함됩니다:

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}