메인 콘텐츠로 건너뛰기
Vantage Mobile Upload는 API 호출을 통해 Vantage 서버와 통신합니다. 이러한 호출은 문서를 생성하고 이미지를 업로드하며, 특정 Parameter를 사용하여 트랜잭션 처리를 시작하는 데 사용됩니다.

​
iOS 플랫폼

Vantage Mobile Input의 iOS 마이크로 애플리케이션은 다음 API 호출을 사용합니다:
  1. 입력 세션의 매개변수를 Vantage Mobile Upload Backend로 전송
  2. Vantage Mobile Upload Backend에서 입력 세션의 매개변수 수신
  3. 트랜잭션 상태 조회
  4. 문서 이미지 분석을 위한 모델 다운로드
  5. 트랜잭션 내 문서 목록 조회
  6. 트랜잭션 내 기존 문서 삭제
  7. 트랜잭션 내 문서 생성
  8. 캡처한 이미지를 문서에 업로드
  9. 트랜잭션 시작

​
Android 플랫폼

Android용 Vantage Mobile Input 마이크로 애플리케이션은 다음 API 호출을 사용합니다:
  1. 트랜잭션 상태 조회
  2. 문서 이미지 분석용 모델 다운로드
  3. 트랜잭션의 문서 목록 조회
  4. 트랜잭션의 기존 문서 삭제
  5. 트랜잭션에 문서 생성
  6. 문서에 캡처한 이미지 업로드
  7. 트랜잭션 시작

​
Vantage Mobile Upload Backend로 입력 세션 매개변수 전송

사용자가 문서 캡처를 언제, 어떤 디바이스에서 시작했는지 기록하려면 POST /api/mobileinputbackend/v1/inputsessions를 사용하세요. 이 리소스는 다음 매개변수를 허용합니다:

​
입력 세션 파라미터

ParameterTypeDescription
transactionIdstring (uuid)필수입니다. 모바일 업로드 링크에 지정된 트랜잭션 식별자입니다.
platformstring필수입니다. 마이크로 애플리케이션이 실행 중인 장치의 모바일 플랫폼입니다. 가능한 값: iOS, Android, Web.
deviceModelstring선택 사항입니다. 마이크로 애플리케이션이 실행 중인 장치의 모델입니다.
OSVersionstring선택 사항입니다. 마이크로 애플리케이션이 실행 중인 장치의 OS 버전입니다.
MIVersionstring선택 사항입니다. 해당 장치에서 실행 중인 Vantage Mobile Input의 버전입니다.

​
Vantage Mobile Upload Backend에서 입력 세션 Parameter 가져오기

사용자가 문서 캡처를 시작한 시점을 확인하려면 GET /api/mobileinputbackend/v1/inputsessions/{transactionId}를 사용합니다. 이 리소스는 다음 Parameter를 반환합니다:

​
입력 세션 파라미터

ParameterTypeDescription
transactionIdstring (uuid)모바일 업로드 링크에 지정된 트랜잭션 식별자입니다.
platformstring마이크로 애플리케이션이 실행되는 디바이스의 모바일 플랫폼입니다. 가능한 값은 iOS, Android, Web입니다.
deviceModelstring마이크로 애플리케이션이 실행되는 디바이스의 모델입니다.
OSVersionstring마이크로 애플리케이션이 실행되는 디바이스의 OS 버전입니다.
MIVersionstring디바이스에서 실행된 Vantage Mobile Input의 버전입니다.
createdAtstring (date-time)입력 세션이 생성된 날짜와 시간입니다.

​
트랜잭션 상태 확인

문서를 캡처하여 업로드할 때 트랜잭션의 현재 상태를 확인하려면 GET /api/publicapi/v1/transactions/{transactionId}를 사용합니다. 이 리소스는 다음을 포함하여 트랜잭션에 대한 정보를 반환합니다:
  • transactionId. 트랜잭션의 고유 식별자
  • status. 현재 트랜잭션 상태(New, Queued, InProgress, Processed 등)
  • createdAt. 트랜잭션이 생성된 시각
  • documents. 트랜잭션에 포함된 문서 배열

​
문서 이미지 분석을 위한 모델 다운로드

문서 이미지의 품질과 유형을 판별하는 머신 러닝 모델을 다운로드하려면 GET /api/mobileinputbackend/v1/models를 사용합니다. 이 엔드포인트는 모바일 앱에서 다음을 수행할 수 있도록 지원하는 모델을 제공합니다:
  • 문서 경계 감지
  • 이미지 품질 점검
  • 문서 유형 식별
  • 캡처된 이미지 유효성 검증

​
트랜잭션의 문서 목록 가져오기

현재 트랜잭션에 연결된 모든 문서를 가져오려면 GET /api/publicapi/v1/transactions/{transactionId}/documents를 사용합니다. 이 리소스는 각 문서에 대해 다음을 포함하는 문서 객체 배열을 반환합니다:
  • id. 문서 식별자
  • name. 문서 이름
  • status. 문서 처리 상태
  • files. 문서와 연결된 파일(이미지)의 배열

​
트랜잭션에서 기존 문서 삭제

처리를 시작하기 전에 트랜잭션에서 문서를 제거하려면 DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}를 사용합니다. 이를 통해 사용자는 다음을 수행할 수 있습니다:
  • 잘못 캡처된 문서 삭제
  • 다시 캡처하기 전에 문서 비우기
  • 트랜잭션 내 문서 집합 관리
참고: 문서는 트랜잭션이 처리를 시작하기 전까지만 삭제할 수 있습니다.

​
트랜잭션에서 문서 생성

이미지 업로드를 위한 새 문서를 트랜잭션 내에 생성하려면 POST /api/publicapi/v1/transactions/{transactionId}/documents를 사용합니다. 요청 본문 예: 
{
  "documents": [
    {
      "name": "Invoice",
      "index": 0
    }
  ]
}
이 호출은 이후 이미지 업로드에 사용할 문서 ID를 반환합니다.

​
캡처한 이미지를 문서에 업로드하기

특정 문서에 캡처한 이미지를 업로드하려면 POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles를 사용합니다. 요청에는 다음이 포함되어야 합니다.
  • 이미지 파일이 포함된 폼 데이터
  • 각 파일에 대한 선택적인 메타데이터
  • 이미지 처리 옵션(autoCrop, autoOrientation)
요청 형식:

​
트랜잭션 시작하기

트랜잭션에 업로드된 모든 문서의 처리를 시작하려면 POST /api/publicapi/v1/transactions/{transactionId}/start를 사용합니다. 이 엔드포인트는 트랜잭션이 생성될 때 지정된 스킬로 처리 워크플로우를 시작합니다. 요청 예시: 시작 후에는 다음과 같은 일이 발생합니다:
  • 트랜잭션 상태가 Queued 또는 InProgress로 변경됩니다
  • 구성된 스킬에 따라 문서가 처리됩니다
  • 상태가 Processed에 도달하면 결과를 사용할 수 있습니다
  • 트랜잭션 상태 엔드포인트를 사용해 진행 상황을 추적할 수 있습니다