제품 및 API 안내

빠른 시작

5분 만에 첫 문서 만들기

이 페이지에서는 아무것도 없는 상태에서 디스크에 PDF를 저장하기까지 안내합니다. 모든 워크스페이스에 처음부터 제공되는 청구서 템플릿을 사용하므로 먼저 디자인할 필요가 없습니다.

1. API 키

계정 → API 키에서 키를 만드세요. 비밀 키는 한 번만 표시되며 소스 코드에 넣지 마세요. 모든 호출에서 X-PDFgine-Key 헤더로 전달합니다.

cURL 
# 키는 코드가 아닌 환경 변수에 설정
export PDFGINE_KEY="pdfgine_live_..."

# 연결 확인: 템플릿 목록 조회
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. 문서 생성

템플릿 코드와 데이터를 지정하여 한 번 호출합니다. 응답은 documentId와 다운로드 URL이 포함된 202입니다.

cURL 
curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "ko",
        "data": {
          "document": { "title": "청구서 요약" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "고장 진단", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

템플릿을 시험할 때는 "purpose": "editor-test"를 보내세요. 이 출력은 한도를 사용하지 않으며 게시되지 않은 초안을 사용합니다.

3. 다운로드

응답의 다운로드 URL은 API 주소 기준 상대 URL이며 같은 키로 가져옵니다. pdf 대신 docx를 요청하면 같은 데이터가 Word 파일로 반환됩니다.

cURL 
curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

처음에 자주 발생하는 문제

  • 402는 월 페이지 한도를 소진했다는 뜻입니다. X-PDFgine-Quota-Remaining 헤더로 소진 전에 잔여량을 확인할 수 있습니다.
  • 422는 데이터가 템플릿 요구 사항을 충족하지 않는다는 뜻입니다. 본문의 errors에 누락된 모든 필드가 표시되므로 추측할 필요가 없습니다.
  • 생성 응답은 200이 아닌 202입니다. 200 이외의 응답을 실패로 처리하는 클라이언트는 성공을 오류로 보고하게 됩니다.

다음으로 볼 내용

데이터 형식은 가장 자주 다시 보게 될 페이지입니다. 날짜, 금액, 통화를 정확히 어떤 형식으로 보내야 하는지 설명합니다.

데이터 형식 →