API 문서 - 압축 인터페이스 전체 설명
SmartSlim 압축 API의 전체 OpenAPI 3.0 사양 문서로, 모든 인터페이스 설명, 매개변수 정의, 오류 코드 참조 및 속도 제한 정책이 포함되어 있습니다
인증 방식
SmartSlim 압축 API는 Bearer Token 방식으로 인증을 수행합니다
Bearer Token
API Key는 HTTP 요청 헤더 Authorization를 통해 전달되며, 형식은 Bearer YOUR_API_KEY입니다. 모든 인터페이스 요청에 이 헤더가 필요하며, 누락되거나 유효하지 않으면 401 오류가 반환됩니다.
전송 보안
모든 API 요청은 HTTPS 암호화 전송을 사용합니다. HTTP 평문 프로토콜로 호출하지 마시고, 전송 중 API Key와 파일 데이터의 보안을 보장하세요.
API Key 관리
API Key는 개발자 콘솔의 애플리케이션 관리에서 조회, 재설정 및 비활성화할 수 있습니다.다양한 환경(개발/테스트/프로덕션)별로 별도의 애플리케이션을 생성하여 격리 및 감사를 용이하게 하는 것을 권장합니다.
# 인증 요청 헤더 예시
Authorization: Bearer YOUR_API_KEY인터페이스 목록
SmartSlim 압축 API는 파일 압축, 작업 관리, 배치 처리 및 사용량 통계 등의 전체 인터페이스를 제공합니다
POST /v1/compress
파일 압축: 단일 파일을 업로드하고 압축을 실행합니다.
file(필수): 압축할 파일quality：압축 품질, 선택 가능low/medium/highformat：출력 형식password(선택): 암호화 압축 비밀번호
GET /v1/tasks/{task_id}
작업 상태 조회: 작업 ID로 압축 작업의 현재 상태와 결과 정보를 가져옵니다.
- 반환
status:pending/processing/completed/failed
GET /v1/tasks/{task_id}/download
압축 파일 다운로드: 작업 완료 후 이 인터페이스를 통해 압축 결과 파일을 다운로드합니다. 파일 스트림이 반환됩니다.
POST /v1/batch/compress
배치 압축: 여러 파일을 한 번에 업로드하여 배치 압축 처리를 수행합니다.
files[](필수): 압축할 파일 배열quality：압축 품질format：출력 형식callback_url(선택): 작업 완료 콜백 주소
GET /v1/usage
사용량 통계 조회: 현재 계정의 사용량 데이터를 가져옵니다. 이번 달 호출 횟수, 압축 파일 총량, 스토리지 사용량 등이 포함됩니다.
DELETE /v1/tasks/{task_id}
작업 삭제: 작업 ID로 지정된 압축 작업과 결과 파일을 삭제하고 스토리지 공간을 해제합니다.
파일 압축 인터페이스 요청 예시
POST /v1/compress HTTP/1.1
Host: api.uglypear.com
Authorization: Bearer YOUR_API_KEY
Content-Type: multipart/form-data; boundary=----FormBoundary
------FormBoundary
Content-Disposition: form-data; name="file"; filename="document.pdf"
Content-Type: application/pdf
(파일 바이너리 내용)
------FormBoundary
Content-Disposition: form-data; name="quality"
high
------FormBoundary
Content-Disposition: form-data; name="format"
pdf
------FormBoundary--작업 상태 조회 응답 예시
{
"task_id": "task_8f3c2a1b9e7d4c5f",
"status": "completed",
"download_url": "https://api.uglypear.com/v1/tasks/task_8f3c2a1b9e7d4c5f/download",
"original_size": 5242880,
"compressed_size": 1572864,
"compression_ratio": "70.0%",
"created_at": "2026-08-05T10:00:00Z",
"completed_at": "2026-08-05T10:00:08Z"
}오류 코드 참조
인터페이스 호출 중 반환될 수 있는 HTTP 상태 코드와 의미 설명으로, 문제 해결 및 예외 처리에 도움이 됩니다
오류 응답 예시
{
"error": {
"code": 429,
"message": "요청 빈도 초과, 현재 플랜 제한은 분당 60회입니다",
"request_id": "req_a1b2c3d4e5f6"
}
}속도 제한 정책
플랜별로 요청 빈도 상한이 다릅니다. 초과 시 429 오류가 반환되므로, 비즈니스 규모에 맞는 플랜을 선택하세요
10
무료 버전
회/분
60
베이직 버전
회/분
300
프로 버전
회/분
제한 없음
엔터프라이즈 버전
주문형 구성
속도 제한은 API Key 단위로 집계되며, 슬라이딩 윈도우 알고리즘으로 분당 요청 수를 계산합니다. 속도 제한이 트리거되면 응답 헤더에 X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset 필드가 반환되어 클라이언트에서 백오프 재시도 전략을 구현할 수 있습니다.
지원 파일 형식
SmartSlim 압축 API는 문서, 이미지, 비디오, 오디오 등 다양한 파일 형식을 지원하여 다양한 압축 요구를 충족합니다
문서 형식
PDF、OFD、DOCX、XLSX、PPTX
이미지 형식
JPG、PNG、TIFF、GIF、BMP
비디오 형식
MP4、AVI、MOV
오디오 형식
MP3、WAV
각 형식별로 지원되는 압축 품질, 출력 옵션 및 용량 제한이 다를 수 있습니다. 자세한 내용은 콘솔과 실제 인터페이스 응답을 확인하세요. 다른 형식 지원이 필요한 경우 영업팀에 문의하여 맞춤 솔루션을 논의하세요.
온라인 디버거
Swagger UI 기반의 온라인 API 디버깅 도구, 출시 예정
시각적 디버깅
온라인 디버거는 시각적인 인터페이스 매개변수 입력 및 요청 전송 기능을 제공하여, 코드 작성 없이 인터페이스 동작과 응답 구조를 빠르게 검증할 수 있습니다.
OpenAPI 3.0 사양
OpenAPI 3.0 사양을 완전히 준수하며, 사양 파일 내보내기를 지원하여 Postman, Apifox 등의 도구에 직접 가져와 로컬 디버깅할 수 있습니다.
출시 예정
Swagger UI 온라인 디버거는 개발 중이며, 출시 후 브라우저에서 직접 전체 인터페이스 디버깅 흐름을 체험할 수 있습니다. 그 전까지는 빠른 시작의 코드 예제를 참조하세요.
빠른 시작 보기