본문으로 건너뛰기

API 개요

ArchiCore REST API를 사용하면 아키텍처 분석을 워크플로에 통합할 수 있습니다.

기본 URL​

https://api.archicore.io/api/v1

인증​

모든 API 요청에는 Bearer 토큰을 사용한 인증이 필요합니다:

curl -H "Authorization: Bearer 귀하의_API_키" \
  https://api.archicore.io/api/v1/projects

API 키 획득에 대한 자세한 내용은 인증을 참조하세요.

응답 형식​

모든 응답은 JSON 형식입니다:

{
  "success": true,
  "data": { ... }
}

오류 응답:

{
  "success": false,
  "error": "오류 메시지",
  "code": "오류_코드"
}

HTTP 상태 코드​

코드설명
200성공
201생성됨
400잘못된 요청 - 유효하지 않은 매개변수
401인증되지 않음 - 유효하지 않거나 누락된 토큰
403금지됨 - 권한 부족
404찾을 수 없음
429요청이 너무 많음 - 속도 제한 초과
500내부 서버 오류

속도 제한​

티어일일 요청분당 요청
무료10010
Pro10,000100
Enterprise무제한1,000

속도 제한 헤더는 모든 응답에 포함됩니다:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

엔드포인트 요약​

프로젝트​

메서드엔드포인트설명
GET/projects모든 프로젝트 목록
POST/projects프로젝트 생성
GET/projects/:id프로젝트 상세 정보
DELETE/projects/:id프로젝트 삭제
POST/projects/:id/index인덱싱 시작

분석​

메서드엔드포인트설명
POST/projects/:id/search시맨틱 검색
POST/projects/:id/askAI 어시스턴트에 질문
GET/projects/:id/metrics코드 메트릭 조회
GET/projects/:id/security보안 스캔 결과
POST/projects/:id/analyze영향 분석

Webhooks​

메서드엔드포인트설명
GET/webhooksWebhook 목록
POST/webhooksWebhook 생성
DELETE/webhooks/:idWebhook 삭제

SDK​

공식 SDK 제공:

  • JavaScript/TypeScript: npm install @archicore/sdk
  • Python: pip install archicore

빠른 예제​

import { ArchiCore } from '@archicore/sdk';

const client = new ArchiCore({ apiKey: '귀하의_API_키' });

// 코드 검색
const results = await client.projects.search('project-id', {
  query: '인증 로직'
});

// AI에 질문
const answer = await client.projects.ask('project-id', {
  question: '인증 시스템은 어떻게 작동하나요?'
});