Skip to content
이 페이지는 AI의 도움으로 작성 및 번역되었습니다. 부정확한 내용이 있으면 개선에 참여해 주세요. GitHub에서 편집

API 개요

Fenfa는 빌드 업로드, 제품 관리, 분석 쿼리를 위한 REST API를 노출합니다. CI/CD 업로드부터 관리 패널 작업까지 모든 프로그래밍 방식 상호 작용은 이 API를 통해 이루어집니다.

기본 URL

모든 API 엔드포인트는 Fenfa 서버 URL을 기준으로 합니다:

https://your-domain.com

인증

보호된 엔드포인트는 X-Auth-Token 헤더가 필요합니다. Fenfa는 두 가지 토큰 범위를 사용합니다:

범위가능한 작업헤더
upload빌드 업로드X-Auth-Token: YOUR_UPLOAD_TOKEN
admin전체 관리 액세스 (업로드 포함)X-Auth-Token: YOUR_ADMIN_TOKEN

토큰은 config.json 또는 환경 변수를 통해 설정됩니다. 설정을 참조하세요.

WARNING

유효한 토큰 없이 보호된 엔드포인트에 요청하면 401 Unauthorized 응답을 받습니다.

응답 형식

모든 JSON 응답은 통합된 구조를 따릅니다:

성공:

json
{
  "ok": true,
  "data": { ... }
}

오류:

json
{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "variant_id is required"
  }
}

오류 코드

코드HTTP 상태설명
BAD_REQUEST400잘못된 요청 파라미터
UNAUTHORIZED401인증 토큰 누락 또는 잘못됨
FORBIDDEN403토큰에 필요한 범위 없음
NOT_FOUND404리소스를 찾을 수 없음
INTERNAL_ERROR500서버 오류

엔드포인트 요약

공개 엔드포인트 (인증 불필요)

방법경로설명
GET/products/:slug제품 다운로드 페이지 (HTML)
GET/d/:releaseID직접 파일 다운로드
GET/ios/:releaseID/manifest.plistiOS OTA 매니페스트
GET/udid/profile.mobileconfig?variant=:idUDID 바인딩 프로파일
POST/udid/callbackUDID 콜백 (iOS에서)
GET/udid/status?variant=:idUDID 바인딩 상태
GET/healthz헬스 체크

업로드 엔드포인트 (업로드 토큰)

방법경로설명
POST/upload빌드 파일 업로드

관리 엔드포인트 (관리 토큰)

방법경로설명
POST/admin/api/smart-upload자동 감지가 있는 스마트 업로드
GET/admin/api/products제품 목록 조회
POST/admin/api/products제품 생성
GET/admin/api/products/:id변형이 있는 제품 가져오기
PUT/admin/api/products/:id제품 업데이트
DELETE/admin/api/products/:id제품 삭제
POST/admin/api/products/:id/variants변형 생성
PUT/admin/api/variants/:id변형 업데이트
DELETE/admin/api/variants/:id변형 삭제
GET/admin/api/variants/:id/stats변형 통계
DELETE/admin/api/releases/:id릴리스 삭제
PUT/admin/api/apps/:id/publish앱 게시
PUT/admin/api/apps/:id/unpublish앱 게시 취소
GET/admin/api/events이벤트 쿼리
GET/admin/api/ios_devicesiOS 기기 목록 조회
POST/admin/api/devices/:id/register-appleApple에 기기 등록
POST/admin/api/devices/register-apple기기 일괄 등록
GET/admin/api/settings설정 가져오기
PUT/admin/api/settings설정 업데이트
GET/admin/api/upload-config업로드 설정 가져오기
GET/admin/api/apple/statusApple API 상태
GET/admin/api/apple/devicesApple 등록된 기기

내보내기 엔드포인트 (관리 토큰)

방법경로설명
GET/admin/exports/releases.csv릴리스 내보내기
GET/admin/exports/events.csv이벤트 내보내기
GET/admin/exports/ios_devices.csviOS 기기 내보내기

ID 형식

모든 리소스 ID는 접두사 + 임의 문자열 형식을 사용합니다:

접두사리소스
prd_제품
var_변형
rel_릴리스
app_앱 (레거시)

상세 레퍼런스

  • 업로드 API -- 필드 레퍼런스와 예제가 있는 업로드 엔드포인트
  • 관리 API -- 전체 관리 엔드포인트 문서

Released under the Apache-2.0 License.