PIPAGuard Developer Docs

REST API v1

PRO 플랜 전용 — 프로그래밍 방식으로 PIPA 컴플라이언스 스캔을 실행하고 결과를 조회합니다.

API 키 생성하기PRO 플랜 필요

인증

모든 요청에 Authorization 헤더를 포함하세요.

Authorization: Bearer pg_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API 키는 대시보드에서 생성할 수 있습니다. 키는 생성 시 한 번만 표시됩니다. 계정당 최대 10개까지 생성 가능합니다.

Rate Limits

PRO 사용자: 100 req/min

모든 응답에 X-RateLimit-Remaining 헤더가 포함됩니다.

엔드포인트

POST/api/v1/scans

답변을 제출하고 PIPA 컴플라이언스 스캔 결과를 즉시 받습니다.

Request Body

{
  "companyName": "주식회사 예시",   // optional
  "answers": {
    "q1_1": "yes",   // yes | no | partial | na
    "q1_2": "no",
    "q2_1": "partial",
    // ... 모든 질문 ID에 대한 답변
  }
}

Response 201

{
  "scanId": "cm9abc123...",
  "score": 82.5,
  "grade": "양호",          // 양호 | 개선 필요 | 위험
  "violations": [
    {
      "questionId": "q1_2",
      "question": "개인정보 처리방침을 공개하고 있습니까?",
      "riskLevel": "critical",  // critical | high | medium | low
      "remediation": "개인정보 처리방침을 웹사이트에 게시하세요.",
      "pipaReference": "개인정보보호법 제30조"
    }
  ],
  "createdAt": "2026-04-02T07:00:00.000Z"
}
GET/api/v1/scans

내 완료된 스캔 목록을 최신순으로 최대 100개 반환합니다.

Response 200

[
  {
    "scanId": "cm9abc123...",
    "score": 82.5,
    "grade": "양호",
    "companyName": "주식회사 예시",
    "createdAt": "2026-04-02T07:00:00.000Z"
  }
]
GET/api/v1/scans/{scanId}

특정 스캔의 전체 상세 정보를 반환합니다.

에러 코드

Status설명
401인증 헤더 없음 또는 유효하지 않은 API 키
403PRO 플랜 전용 기능
400잘못된 요청 (answers 없음 또는 유효하지 않은 값)
429Rate limit 초과 (100 req/min)
404스캔을 찾을 수 없음

예시 (curl)

curl -X POST https://pipaguard.vercel.app/api/v1/scans \
  -H "Authorization: Bearer pg_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "테스트 회사",
    "answers": {
      "q1_1": "yes",
      "q1_2": "no",
      "q2_1": "partial"
    }
  }'
대시보드 API 키 관리