메인 콘텐츠로 건너뛰기
별도의 API 호출(트랜잭션 생성, 파일 업로드, 트랜잭션 시작)을 통해 문서를 처리하는 전형적인 시나리오는 다음 단계로 구성됩니다:
  1. 사용 가능한 모든 Skill 목록 조회
  2. 빈 트랜잭션 생성
  3. 트랜잭션에서 처리할 파일 집합 추가
  4. 트랜잭션 시작
  5. 트랜잭션 상태 모니터링
  6. 원본 파일 및 결과 파일 다운로드
각 서버 요청에는 액세스 토큰과 같은 인증 정보가 포함되어야 합니다. 자세한 내용은 Authentication을 참조하세요.

사용 가능한 모든 스킬 목록 가져오기

이를 위해서는 skills 리소스에 GET 요청을 전송합니다: 다음 명령을 실행합니다: 요청이 성공하면 애플리케이션 인스턴스에 추가된 모든 스킬에 대한 정보를 받게 됩니다.

빈 트랜잭션 생성

그러려면 transactions 리소스로 다음 POST 요청을 전송합니다: 다음 명령을 실행합니다: 요청 본문에 이전 API 호출에서 반환된 skillId 매개변수를 지정합니다. 그러면 생성된 트랜잭션의 id가 포함된 응답을 받게 됩니다.

트랜잭션에서 처리할 파일 집합 추가

중요! 하나의 트랜잭션에 포함될 수 있는 최대 파일 수는 1000개입니다. 파일 집합을 추가하는 방법에는 두 가지가 있습니다.

트랜잭션에 파일을 직접 추가하기

이 작업을 위해 transactions/<transaction-id>/files 리소스에 POST 요청을 전송합니다: 다음 명령을 실행합니다: 그 결과, 추가된 파일과 해당 식별자 목록이 포함된 응답을 받게 됩니다. 이 호출을 여러 번 반복하여 필요한 만큼 많은 파일을 추가할 수 있습니다. 파일 업로드를 위한 추가 옵션은 다음과 같습니다.

문서에 파일 추가하기

먼저 transactions/<transaction-id>/documents 리소스에 POST 요청을 보내 문서를 생성합니다: As a result, you will receive a response with the document identifier. 이 요청의 결과로 문서 식별자가 포함된 응답을 받습니다. Then add files to the document by sending a POST request to the transactions/<transaction-id>/documents/<document-id>/sourceFiles resource: 다음으로 transactions/<transaction-id>/documents/<document-id>/sourceFiles 리소스에 POST 요청을 보내 문서에 파일을 추가합니다:

트랜잭션 시작하기

지정한 스킬과 파일을 사용하여 트랜잭션을 시작하려면 transactions/<transaction-id>/start 리소스에 다음과 같은 POST 요청을 전송합니다:

트랜잭션 상태 모니터링

짧은 타임아웃을 두고 루프로 트랜잭션 상태 모니터링을 시작하려면(1초에 한 번보다 더 자주 상태를 확인하는 것은 권장하지 않습니다), 요청 URI에 트랜잭션 식별자를 포함하여 transactions/<transaction_id> 리소스에 GET 요청을 전송하십시오: 이 요청의 결과로 트랜잭션 상태가 포함된 응답을 받게 됩니다. 트랜잭션 처리는 다음 상태 중 하나일 수 있습니다:
  • New. 트랜잭션이 생성되었지만 아직 처리 대기열에 추가되지 않았습니다.
  • Queued. 트랜잭션이 처리 대기열에 추가되었습니다.
  • InProgress. 트랜잭션이 처리 중입니다.
  • Processed. 트랜잭션이 성공적으로 처리되었습니다.
  • ProcessedWithWarnings. 트랜잭션이 처리되었지만 경고가 발생했습니다.
  • NotProcessed. 오류로 인해 트랜잭션이 처리되지 않았습니다.
  • Deleted. 트랜잭션이 사용자가 삭제했거나 보존 정책에 따라 자동으로 삭제되었습니다.
트랜잭션 상태가 Processed 또는 ProcessedWithWarnings인 경우 6단계로 진행합니다.

소스 파일 다운로드

문서 목록과 각각의 식별자를 요청하려면 transactions/<transaction-id>/documents 리소스에 GET 요청을 보내고 트랜잭션 식별자를 지정합니다: 응답으로 이 트랜잭션 내에서 생성된 모든 문서 목록을 받게 됩니다. 응답에는 특정 문서에 대한 상세 정보를 요청할 때 필요할 수 있는 해당 문서들의 식별자도 포함됩니다. 특정 문서에 추가된 파일 목록을 요청하려면 transactions/<transaction-id>/documents/<document-id> 리소스에 GET 요청을 보냅니다: 응답으로 해당 문서에 대한 정보를 받게 됩니다. 응답에는 문서에 추가된 파일들의 식별자도 포함됩니다. 소스 파일을 다운로드하려면 transactions/<transaction-id>/files/<file-id>/download 리소스에 GET 요청을 보냅니다: