KodaPdf 설명서 및 가이드

인증 및 API 키 관리

API는 모든 개발자 엔드포인트에 대해 상태 비저장 JWT 인증을 사용합니다. 모든 요청의 헤더에 고유한 API 키를 포함해야 합니다. 개발자 API 키 프로필 설정에서 생성됩니다.

X-Api-Key: Your_Developer_API_Key
Content-Type: application/json

1단계: 변환할 파일 업로드

API를 통해 작업을 수행하기 전에 파일을 시스템에 업로드해야 합니다. 이 엔드포인트는 다중 부분/양식 데이터 전송 형식을 허용합니다.

요청 예시 (언어별 선택):

curl -X POST "https://kodapdf.com/api/files/upload" \
  -H "X-Api-Key: Your_Developer_API_Key" \
  -F "file=@report.docx"

성공적인 응답 (JSON - 201 Created):

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "fileName": "report.docx",
  "size": 4194304
}

HTTP 응답 코드:

2단계: 비동기 작업 큐 흐름

파일을 업로드하고 파일 ID 를 받은 후, 대상 변환 또는 PDF 조작 엔드포인트에 요청을 보내 백그라운드 작업을 실행합니다. 완료되면 안전한 다운로드 링크를 얻을 수 있습니다.

작업 상태 추적 (폴링 또는 웹훅)

반환된 ID를 사용하여 일정 간격으로 작업 상태를 쿼리(GET)합니다. 직업 ID 다음 URL 끝점에서:

작업 쿼리 예:

curl -X GET "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b" \
  -H "X-Api-Key: Your_Developer_API_Key"

반환된 응답 (작업 완료 성공):

{
  "id": "e4f8d22c-a2b1-4f33-bd54-72123456789b",
  "status": "Completed",
  "fileName": "report.pdf",
  "downloadUrl": "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b/download"
}

작업 수명 주기 상태:

REST API 엔드포인트 레퍼런스

가장 자주 사용되는 비동기 작업 파라미터 및 API 템플릿입니다. 파일을 업로드한 후 반환된 파일 ID 를 JSON 요청 바디에 전달하세요:

curl -X POST "https://kodapdf.com/api/jobs" \
  -H "X-Api-Key: Your_Developer_API_Key" \
  -H "Content-Type: application/json" \
  -d '{
    "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
    "sourceFormat": "docx",
    "targetFormat": "pdf",
    "originalFileName": "report.docx"
  }'

{
  "fileIds": [
    "8a7c93e4-b78f-4ad5-9c60-06123456789a",
    "9b8d04f5-c89g-5be6-0d71-1723456789ab"
  ],
  "outputFileName": "merged_document.pdf"
}

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "text": "CONFIDENTIAL",
  "opacity": 0.25,
  "outputFileName": "watermarked.pdf"
}

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "patterns": ["SECRET", "05\\d{9}"],
  "outputFileName": "redacted.pdf"
}

웹훅 알림 (콜백 API)

당사 시스템은 작업 완료 시 웹 서비스에 직접 핑을 보내 GET 쿼리를 통한 수동 폴링을 방지하는 자동화된 Webhook 구독을 지원합니다. 우편 /api/웹훅/구독

구독 요청 본문:

{
  "target_url": "https://api.yoursite.com/kodapdf-callback",
  "event_type": "job.completed"
}

완료 시 서버로 전송되는 JSON(페이로드):

{
  "id": "e4f8d22c-a2b1-4f33-bd54-72123456789b",
  "fileName": "report.pdf",
  "status": "Completed",
  "sourceFormat": "docx",
  "targetFormat": "pdf",
  "downloadUrl": "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b/download",
  "event_type": "job.completed"
}