API REST (Representational State Transfer)

REST API란 무엇입니까?

REST API(Representational State Transfer)는 웹 서비스를 구축하기 위한 일련의 제약 조건을 정의하는 소프트웨어 아키텍처 스타일입니다. 표준 HTTP 프로토콜을 사용하며, 서로 다른 애플리케이션들이 간단하고 표준화된 방식으로 통신할 수 있게 해줍니다.

기본 원칙

• 클라이언트-서버: 클라이언트(사용자의 애플리케이션)가 서버(API)에 요청을 보내면 서버가 이를 처리하고 데이터를 반환합니다
• 무상태(stateless): 각 요청에는 필요한 모든 정보가 담겨 있으며, 서버는 요청 간 컨텍스트를 저장하지 않습니다
• URL로 식별되는 리소스: 모든 데이터는 고유한 URL(엔드포인트)을 통해 접근할 수 있습니다
• HTTP 메서드: GET(조회), POST(생성), PUT(수정), DELETE(삭제)

데이터 형식

현대의 REST API는 데이터 교환을 위해 주로 JSON(JavaScript Object Notation) 형식을 사용합니다. 이 형식은 가볍고 사람이 읽기 쉬우며 모든 프로그래밍 언어에서 쉽게 파싱할 수 있습니다.

REST API와 AILabsAudit

AILabsAudit은 https://ailabsaudit.com/api/v1/에서 총 119개의 엔드포인트(읽기 87개 + 쓰기 32개)로 구성된 공개 REST API를 완비하여 제공합니다.

• 읽기 엔드포인트 87개는 클라이언트, 감사, 리포트, 실행 계획, 분석, 트래킹, 할루시네이션, 에이전시, 블로그, 용어집, 설문, GEO 체크리스트, 예약 감사, GEO 쇼케이스를 다룹니다. 서드파티 대시보드, CRM, N8N 워크플로에 AILabsAudit 데이터를 연동하는 데 이상적입니다.
• 쓰기 엔드포인트 32개를 통해 클라이언트 생성, 감사 실행, 화이트라벨 PDF 리포트 생성, 에이전트 관리, 프롬프트 업데이트, 실행 계획 액션 트리거가 가능합니다.

인증은 API 키(X-Api-Key: aila_* 또는 Authorization: Bearer)를 통해 이루어지며, 기본 할당량은 분당 60회 요청이고, X-RateLimit-Remaining/X-RateLimit-Reset 헤더가 제공되며 모든 응답은 페이지네이션된 JSON 형식입니다.