다양한 유형의 파일을 원하는 형식으로 변환하는 솔루션입니다. 신속하고 편리하게 높은 품질의 문서 변환 서비스를 만들어 보세요.

개발 가이드

개요

한컴 통합문서뷰어

한컴 통합문서뷰어의 API를 직접 호출하여 결과를 확인해 보세요.

한컴 통합문서뷰어 예제

개발자와 의견을 나누고 문제를 해결하거나 제품을 구매하여 활용해 보세요!

한컴 로그인은 한글과컴퓨터 서비스에서 제공하는 OAuth2.0 기반의 간편 로그인 기능입니다.

한컴 계정

한컴 OCR은 이미지나 PDF 파일에 포함된 글자를 추출하는 솔루션입니다. 다양한 유형의 문서와 이미지에서 텍스트를 인식하고 추출하는 기능을 제공합니다.

한컴 OCR

한컴싸인에서 제공하는 Webhook/API 사용 방법에 대한 가이드입니다. Webhook/API를 통해 한컴싸인을 쉽고 빠르게 연동하여 사용할 수 있습니다.

한컴싸인

OLE Automation을 통해 한글 프로그램을 자동화하는 방법에 대한 가이드입니다. 외부 클라이언트에서 OLE(COM) Object를 이용하여 한글 기능을 실행하거나 문서를 제어할 수 있습니다.

한글 오토메이션


| HTTP 메서드 | 엔드포인트 | 설명 |
|------------|------------|------|
| POST | `/argoocr` | OCR 인식 |
| POST | `/argodocument` | 문서 인식 |
| GET | `/ping` | 서버 상태 확인 |
| GET | `/log/{logType}` | 서버 로그 조회 |
| GET | `/status` | 서버 상태 조회 |
| GET | `/restart` | 서버 및 엔진 재시작 |


각 엔드포인트에 대한 자세한 사용법과 파라미터는 해당 섹션에서 확인할 수 있습니다.


## **1. 한컴 OCR**

한컴 OCR API는 이미지나 PDF 파일에서 텍스트를 추출하는 광학 문자 인식(OCR) 서비스를 제공합니다. 이 API는 다양한 글꼴과 복잡한 레이아웃의 문서에서도 높은 정확도로 텍스트를 인식합니다.

주요 기능:
- 다양한 이미지 형식(JPEG, PNG, TIFF 등) 및 PDF 파일 지원
- 페이지 레이아웃 분석
- 단어 및 라인 단위의 텍스트 추출
- 텍스트 위치 정보(bounding box) 제공
- 인식 신뢰도 점수 제공

| 항목 | 설명 |
|------|------|
| **API** | `http://{ip}:{port}/argoocr` |
| **Method** | POST |
| **Content-Type** | multipart/form-data |

### Request Parameters

| 파라미터 | 타입 | 필수 | 설명 |
|----------|------|------|------|
| key | str | O | 라이선스 키 (32자) |
| request_id | str | O | 요청 고유 식별자 |
| file_format | str | O | 파일 형식 (pdf / image) |
| file_url | str | X | 파일 URL |
| file_bytes | str | X | Base64 인코딩된 파일 데이터 |
| file_upload | str($binary) | X | 업로드할 파일 |

### Response

| 필드 | 타입 | 설명 |
|------|------|------|
| result | string | 처리 결과 상태 ("OK" 등) |
| request_id | string | 요청 시 전달한 고유 식별자 |
| file_format | string | 처리된 파일 형식 |
| content | object | OCR 처리 결과 데이터 |
| content.file_path | string or null | 처리된 파일 경로 |
| content.page_count | integer | 처리된 페이지 수 |
| content.ocr_data | array | 각 페이지의 OCR 결과 |
| content.ocr_data[].page_number | integer | 페이지 번호 |
| content.ocr_data[].image_width | integer | 이미지 너비 |
| content.ocr_data[].image_height | integer | 이미지 높이 |
| content.ocr_data[].image_rotation | integer | 이미지 회전 각도 |
| content.ocr_data[].words | array | 인식된 단어 목록 |
| content.ocr_data[].words[].word_id | integer | 단어 ID |
| content.ocr_data[].words[].bbox | array | 단어 경계 상자 좌표 [x1, y1, x2, y2, x3, y3, x4, y4] |
| content.ocr_data[].words[].text | string | 인식된 텍스트 |
| content.ocr_data[].words[].score | string | 인식 신뢰도 점수 |
| content.ocr_data[].lines | array | 인식된 텍스트 라인 목록 |
| content.ocr_data[].lines[].line_id | integer | 라인 ID |
| content.ocr_data[].lines[].words_id | array | 라인에 포함된 단어 ID 목록 |
| content.ocr_data[].lines[].bbox | array | 라인 경계 상자 좌표 [x1, y1, x2, y2, x3, y3, x4, y4] |
| content.ocr_data[].lines[].text | string | 라인의 전체 텍스트 |
| content.ocr_data[].page_text | string | 페이지의 전체 텍스트 |
| images_data | null or array | 이미지 데이터 (일반적으로 null) |
| msg | string | 처리 결과 메시지 |

### 요청 예시

```bash
curl -X POST "https://hancom-ocr.hancom.com:5000/argoocr" \
  -H "Content-Type: multipart/form-data" \
  -F "key=your_license_key" \
  -F "request_id=unique_id_123" \
  -F "file_format=image" \
  -F "file_upload=@/path/to/image.jpg"
```

### 응답 예시

```json
{
  "result": "OK",
  "request_id": "unique_id_123",
  "file_format": "image",
  "content": {
    "file_path": null,
    "page_count": 1,
    "ocr_data": [
      {
        "page_number": 1,
        "image_width": 100,
        "image_height": 52,
        "image_rotation": 0,
        "words": [
          {
            "word_id": 0,
            "bbox": [14, 15, 80, 15, 80, 28, 14, 28],
            "text": "안녕하세요.",
            "score": "0.97238004"
          }
        ],
        "lines": [
          {
            "line_id": 0,
            "words_id": [0],
            "bbox": [14, 15, 80, 15, 80, 28, 14, 28],
            "text": "안녕하세요."
          }
        ],
        "page_text": "안녕하세요."
      }
    ]
  },
  "images_data": null,
  "msg": "이미지 인식 완료"
}
```

## **2. 한컴 Document**

한컴 Document API는 구조화된 문서 처리와 정보 추출을 위한 문서 인식 서비스입니다. OCR 기능을 기반으로 하며, 추가적으로 key-value추출, 문서 구조 분석, 폼 인식, 템플릿 매칭 등의 기능을 제공합니다.

주요 기능:
- OCR 텍스트 추출
- key-value 추출
- 문서 레이아웃 분석
- 폼 필드 인식 및 데이터 추출
- 사전 정의된 템플릿과의 매칭
- 특정 도메인에 최적화된 문서 처리 (예: 영수증, 청구서, 계약서 등)
- 추출된 데이터의 구조화

| 항목 | 설명 |
|------|------|
| **API** | `http://{ip}:{port}/argodocument` |
| **Method** | POST |
| **Content-Type** | multipart/form-data |

### Request Parameters

| 파라미터 | 타입 | 필수 | 설명 |
|----------|------|------|------|
| key | str | O | 라이선스 키 (32자) |
| request_id | str | O | 요청 고유 식별자 |
| domain_id | int | O | 문서 도메인 ID |
| file_format | str | O | 파일 형식 (pdf / image) |
| template_id | int | X | 템플릿 ID |
| file_url | str | X | 파일 URL |
| file_bytes | str | X | Base64 인코딩된 파일 데이터 |
| file_upload | str($binary) | X | 업로드할 파일 |

### Response

| 필드 | 타입 | 설명 |
|------|------|------|
| result | string | 처리 결과 상태 ("OK" 등) |
| request_id | string | 요청 시 전달한 고유 식별자 |
| file_format | string | 처리된 파일 형식 |
| content | object | 문서 처리 결과 데이터 |
| content.page_count | integer | 처리된 페이지 수 |
| content.ocr_data | array | 각 페이지의 OCR 결과 |
| content.ocr_data[].page_number | integer | 페이지 번호 |
| content.ocr_data[].image_width | integer | 이미지 너비 |
| content.ocr_data[].image_height | integer | 이미지 높이 |
| content.ocr_data[].image_rotation | integer | 이미지 회전 각도 |
| content.ocr_data[].words | array | 인식된 단어 목록 |
| content.ocr_data[].words[].word_id | integer | 단어 ID |
| content.ocr_data[].words[].bbox | array | 단어 경계 상자 좌표 [x1, y1, x2, y2, x3, y3, x4, y4] |
| content.ocr_data[].words[].text | string | 인식된 텍스트 |
| content.ocr_data[].words[].score | string | 인식 신뢰도 점수 |
| content.ocr_data[].lines | array | 인식된 텍스트 라인 목록 |
| content.ocr_data[].lines[].line_id | integer | 라인 ID |
| content.ocr_data[].lines[].words_id | array | 라인에 포함된 단어 ID 목록 |
| content.ocr_data[].lines[].bbox | array | 라인 경계 상자 좌표 [x1, y1, x2, y2, x3, y3, x4, y4] |
| content.ocr_data[].lines[].text | string | 라인의 전체 텍스트 |
| content.ocr_data[].page_text | string | 페이지의 전체 텍스트 |
| content.forms_data | array | 폼 인식 결과 데이터 |
| content.forms_data[].bbox | array | 폼 요소의 경계 상자 좌표 |
| content.forms_data[].type | integer | 폼 요소 타입 |
| content.forms_data[].confidence | number | 인식 신뢰도 |
| content.forms_data[].text | string | 인식된 텍스트 |
| content.template_data | array | 템플릿 매칭 결과 |
| content.template_data[].name | string | 매칭된 템플릿 이름 |
| content.template_data[].ids | array | 매칭된 템플릿 ID 목록 |
| content.extract_data | array | 추출된 데이터 (비어있을 수 있음) |
| images_data | null or array | 이미지 데이터 (일반적으로 null) |
| msg | string | 처리 결과 메시지 |
| domain_id | integer | 처리된 문서의 도메인 ID |

### 요청 예시

```bash
curl -X POST "https://hancom-ocr.hancom.com:5000/argodocument" \
  -H "Content-Type: multipart/form-data" \
  -F "key=your_license_key" \
  -F "request_id=unique_id_456" \
  -F "domain_id=106" \
  -F "file_format=pdf" \
  -F "file_upload=@/path/to/document.pdf"
```

### 응답 예시

```json
{
  "result": "OK",
  "request_id": "unique_id_456",
  "file_format": "image",
  "content": {
    "page_count": 1,
    "ocr_data": [
      {
        "page_number": 1,
        "image_width": 100,
        "image_height": 52,
        "image_rotation": 0,
        "words": [
          {
            "word_id": 0,
            "bbox": [14, 15, 80, 15, 80, 28, 14, 28],
            "text": "안녕하세요.",
            "score": "0.97238004"
          }
        ],
        "lines": [
          {
            "line_id": 0,
            "words_id": [0],
            "bbox": [14, 15, 80, 15, 80, 28, 14, 28],
            "text": "안녕하세요."
          }
        ],
        "page_text": "안녕하세요."
      }
    ],
    "forms_data": [
      {
        "bbox": [11, 13, 84, 32],
        "type": 2,
        "confidence": 1,
        "text": "안녕하세요."
      }
    ],
    "template_data": [
      {
        "name": "",
        "ids": []
      }
    ],
    "extract_data": []
  },
  "images_data": null,
  "msg": "SUCCESS",
  "domain_id": 107
}
```

## **3. Ping**

Ping API는 서버의 상태와 가용성을 확인하기 위한 간단한 헬스체크 엔드포인트입니다. 이 API를 사용하여 서버가 정상적으로 응답하는지 빠르게 확인할 수 있습니다.

주요 기능:
- 서버 상태 확인
- 간단한 응답 시간 측정

| 항목 | 설명 |
|------|------|
| **API** | `http://{ip}:{port}/ping` |
| **Method** | GET |
| **Request** | - |

### Response

| 타입 | 데이터 |
|------|--------|
| JSON | Key name: message, Type: str |

### 요청 예시

```bash
curl -X GET "https://hancom-ocr.hancom.com:5000/ping"
```

### 응답 예시

```json
{
  "message": "pong"
}
```

## **4. Log**

Log API는 서버의 로그 정보를 조회할 수 있는 엔드포인트입니다. 이 API를 통해 오류 정보, 사용 통계 등 다양한 로그 데이터에 접근할 수 있습니다.

주요 기능:
- 다양한 유형의 로그 조회 (에러 로그, 액세스 로그 등)
- 로그 필터링 및 검색
- 특정 기간의 로그 데이터 추출

| 항목 | 설명 |
|------|------|
| **API** | `http://{ip}:{port}/log/{logType}?count={count}` |
| **Method** | GET |
| **Request** | - |

### Request Parameters

| 파라미터 | 타입 | 필수 | 설명 |
|----------|------|------|------|
| logType | string | O | 로그 타입 (server, access, engine, processing, error) |
| count | integer | X | 반환할 로그 항목 수 (기본값: 50) |

### Response

| 필드 | 타입 | 설명 |
|------|------|------|
| LOGS | array of string | 로그 항목 목록 |
| MSG | string | 처리 결과 메시지 |


### 요청 예시

```bash
# 서버 로그 최근 30개 항목 조회
curl -X GET "http://example.com:8081/log/server?count=30"

# 에러 로그 최근 50개 항목 조회 (count 기본값 사용)
curl -X GET "http://example.com:8081/log/error"

# 엔진 로그 최근 100개 항목 조회
curl -X GET "http://example.com:8081/log/engine?count=100"
```

### 응답 예시

```json
{
  "LOGS": [
    "2024-09-22 10:15:32 [INFO] Server started successfully",
    "2024-09-22 10:16:45 [DEBUG] Processing request ID: REQ123456",
    "2024-09-22 10:17:10 [ERROR] Failed to load image: file_not_found.jpg",
    // ... 추가 로그 항목들 ...
  ],
  "MSG": "Log retrieval successful"
}
```

## **5. Status**

Status API는 OCR 서버의 현재 상태와 각 구성 요소의 운영 상태를 제공합니다. 이 API를 통해 서버의 전반적인 건강 상태와 각 서비스(OCR, 문서 처리 등)의 개별 상태를 확인할 수 있습니다.

주요 기능:
- 전체 시스템 상태 확인
- 개별 서비스 구성 요소의 상태 확인
- 상세한 상태 정보 제공 (준비 중, 가동 중, 정지 등)

| 항목 | 설명 |
|------|------|
| **API** | `http://{ip}:{port}/status` |
| **Method** | GET |
| **Request** | - |

### Response

| 키 | 타입 | 값 |
|-----|------|-----|
| STATUS | str | INIT: 준비 중<br>RUNNING: 가동 중<br>STOPPED: 사용자의 요청으로 인한 정지<br>BROKEN: 오류 및 기타 이유로 인한 정지 |
| OCR | dictionary | OCR 상태 정보 |
| FORM | dictionary | 폼 처리 상태 정보 |
| DOCUMENT | dictionary | 문서 처리 상태 정보 |
| MSG | str | 상태 메시지 |

### 요청 예시

```bash
curl -X GET "https://hancom-ocr.hancom.com:5000/status"
```

### 응답 예시

```json
{
  "STATUS": "RUNNING",
  "OCR": {
    "IS_STOP": false,
    "IS_PROCESSING": false,
    "STATUS": "RUNNING"
  },
  "FORM": {
    "IS_STOP": false,
    "IS_PROCESSING": true,
    "STATUS": "RUNNING"
  },
  "DOCUMENT": {
    "IS_STOP": false,
    "IS_PROCESSING": false,
    "STATUS": "RUNNING"
  },
  "MSG": "All systems operational"
}
```

## **6. Restart**

Restart API는 OCR 서버와 관련 서비스를 원격으로 재시작할 수 있는 기능을 제공합니다. 이 API는 시스템 관리자나 자동화된 관리 시스템에서 서버 문제 해결이나 업데이트 후 재시작 등의 목적으로 사용될 수 있습니다.

주요 기능:
- 서버 및 관련 서비스의 원격 재시작
- 재시작 프로세스 상태 확인

| 항목 | 설명 |
|------|------|
| **API** | `http://{ip}:{port}/restart` |
| **Method** | GET |
| **Request** | - |

### Response

| 타입 | 데이터 |
|------|--------|
| JSON | Key name: message, Type: str |

### 요청 예시

```bash
curl -X GET "https://hancom-ocr.hancom.com:5000/restart"
```

### 응답 예시

```json
{
  "message": "Server restarting"
}
```

## 주의사항

1. 실제 사용 시 `서버주소:포트`를 올바른 값으로 대체하세요.
2. 파일 업로드 시 실제 파일 경로를 사용하세요.
3. `request_id`는 각 요청마다 고유해야 합니다.
4. 필요한 경우 인증 정보(예: API 키)를 요청에 포함하세요.
5. `file_bytes` 사용 시 이미지 데이터를 Base64로 인코딩하세요.


API 엔드포인트

URI의 구성

변환 쌍 및 모듈명과 변환 API

매개 변수

응답 형식

응답 코드

문서 변환 API

file_path

ext_to

error code

HTML 문서 뷰어 API

릴리즈 노트

docsconverter

공통 가이드 

한컴 OAuth 로그인 

디자인 리소스 

hancomaccount

URL의 구성

에러 처리

제품 유지 보수

hancomocr

Webhook

hancomsign-api

구성/구조/지원되는 파일 형식

한글 컨트롤(ActiveX 기반) 대비 API 변경 사항

웹한글 기안기 API 기본 사용법

Properties

Methods

Action

CtrlCode

ParameterSet

ParameterArray

HwpCtrl

webhwp

한컴디벨로퍼

데스크톱에 한컴오피스 한글을 설치하지 않아도 웹 브라우저에 접속하여 한글 프로그램을 사용할 수 있습니다. 전자 결재를 상신하거나 양식 문서 또는 각종 보고서를 작성하는 시스템과 연동하여 활용해 보세요.

웹한글 기안기

웹한글 기안기의 API 예제를 직접 작성하여 결과를 확인해 보세요. 활용 가능한 API 정보는 문서 &gt; 개발 가이드 →를 통해 확인할 수 있습니다.

PDF 다운로드

웹한글 기안기 예제