AIMON Public API v1
외부 VMS·Vision AI·업무 시스템에서 탐지를 전송하거나 사건을 조회할 때 사용하는 안정적인 외부 API입니다.
시작 전 확인
API를 사용하려면 AIMON 조직, 사용할 기능 활성화, 접근 사이트가 지정된 API 키, 테스트/운영 환경 구분이 필요합니다.
API를 사용하려면 AIMON 조직, 사용할 기능 활성화, 접근 사이트가 지정된 API 키, 테스트/운영 환경 구분이 필요합니다.
Base URL: https://api-gateway-production-20f8.up.railway.app/v1
OpenAPI: https://api-gateway-production-20f8.up.railway.app/openapi/v1.json
인증
요청 헤더에 발급받은 API 키를 포함합니다.
X-Aimon-Api-Key: aimon_live_…Authorization: Bearer aimon_live_…
API 키를 브라우저 코드, 공개 저장소, 메신저에 직접 저장하지 마세요. 응답에는 apiVersion: "v1"이 포함됩니다.
주요 엔드포인트
| Method | Path | API 권한 | 설명 |
|---|---|---|---|
| POST | /v1/vision/detections | vision:ingest | 외부 시스템의 탐지 이벤트 전송 |
| GET | /v1/incidents | incident:read | 사건 목록 |
| GET | /v1/incidents/:id | incident:read | 사건 상세 |
| POST | /v1/incidents | incident:write | 사건 생성 |
예시 — 사건 목록
curl "https://api-gateway-production-20f8.up.railway.app/v1/incidents?siteId=site_demo" \
-H "X-Aimon-Api-Key: aimon_live_..."요청 한도
조직 플랜별 분당 요청 한도가 적용됩니다. 초과 시 429와 retryAfterSec을 반환합니다. 응답의 대기 시간 후 다시 시도하세요.
자주 보는 오류
- 401 — API 키가 없거나 유효하지 않습니다.
- 403 — 필요한 API 권한이 없거나 조직에서 해당 기능을 사용하지 않습니다.
- 429 — 요청 한도 초과.
retryAfterSec후 재시도하세요.
외부 연동과 콘솔 API의 구분
파트너·VMS·ITSM 연동은 반드시 버전이 관리되는
/v1 Public API만 사용하세요. 운영 콘솔이 사용하는 내부 경로는 변경될 수 있으며 외부 계약이 아닙니다.