AEM Forms as a Cloud Service 통신 API frequently-asked-questions

영웅 이미지

버전
문서 링크
AEM 6.5
여기 클릭
AEM as a Cloud Service
이 문서

커뮤니케이션 기능은 비즈니스 서신, 명세서, 요청 처리 레터, 혜택 공지, 월별 청구서 또는 시작 키트 등 개인화 및 표준화된 브랜드 승인 문서를 만드는 데 도움이 됩니다.

이 기능은 문서를 생성하고 조작하는 API를 제공합니다. 주문형 문서를 생성 또는 조작하거나 배치 작업을 생성하여 정의된 간격으로 여러 문서를 생성할 수 있습니다. 통신 API는 다음 사항을 제공합니다.

  • 간소화된 온디맨드 및 배치 문서 생성 기능.

  • 주문형 PDF 문서를 결합하고, 재배열하고 확인하는 기능.

  • 더 쉽게 외부 시스템과 통합할 수 있는 HTTP API. 온디맨드(낮은 대기 시간) 및 배치 작업(처리량이 많은 작업)용 별도 API가 포함됩니다.

  • 데이터에 대한 보안 액세스. 통신 API는 고객이 지정한 데이터 저장소의 데이터에만 연결하고 액세스하여 커뮤니케이션의 보안 수준을 높입니다.

문서 생성

통신 문서 생성 API는 템플릿(XFA 또는 PDF)을 고객 데이터(XML)와 결합하여 PS, PCL, DPL, IPL, ZPL 등 PDF 및 인쇄 형식으로 문서를 생성하는 데 도움이 됩니다. 해당 API는 XML 데이터가 포함된 PDF 및 XFA 템플릿을 활용하여 배치 작업을 통해 주문형 단일 문서이나 여러 문서를 생성합니다.

일반적으로 디자이너를 사용하여 템플릿을 만들고 통신 API를 사용하여 데이터를 템플릿과 병합합니다. 애플리케이션은 출력 문서를 네트워크 프린터, 로컬 프린터 또는 스토리지 시스템에 전송하여 보관합니다. 일반적인 기본 제공 및 사용자 지정 워크플로는 다음과 같습니다.

통신 문서 생성 워크플로

사용 사례에 따라 웹 사이트나 스토리지 서버를 통해 해당 문서를 다운로드할 수도 있습니다.

문서 생성 API의 몇 가지 예는 다음과 같습니다.

PDF 문서 만들기 create-pdf-documents

문서 생성 API를 사용하여 양식 디자인과 XML 양식 데이터를 기반으로 하는 PDF 문서를 만들 수 있습니다. 출력은 비대화형 PDF 문서입니다. 즉, 사용자는 양식 데이터를 입력하거나 수정할 수 없습니다. 기본 워크플로는 XML 양식 데이터를 양식 디자인과 병합하여 PDF 문서를 만드는 것입니다. 다음 일러스트레이션은 양식 디자인과 XML 양식 데이터를 병합하여 PDF 문서를 생성하는 모습을 보여 줍니다.

PDF 문서 만들기
그림: PDF 문서를 만드는 일반적인 워크플로

PS(PostScript), PCL(Printer Command Language), ZPL(Zebra Printing Language) 문서 만들기 create-PS-PCL-ZPL-documents

문서 생성 API를 사용하여 XDP 양식 디자인 또는 PDF 문서를 기반으로 하는 PostScript(PS), 프린터 명령 언어(PCL) 및 Zebra 인쇄 언어(ZPL) 문서를 만들 수 있습니다. 해당 API는 양식 디자인을 양식 데이터와 병합하여 문서를 생성하는 데 도움이 됩니다. 문서를 파일에 저장하고, 사용자 지정 프로세스를 개발하여 프린터에 전송할 수 있습니다.

배치 데이터를 처리하여 여러 문서 만들기 processing-batch-data-to-create-multiple-documents

문서 생성 API를 사용하여 XML 배치 데이터 소스 내의 각 기록에 별도의 문서를 만들 수 있습니다. 비동기화 모드에서 문서를 일괄 생성할 수 있습니다. 다양한 매개변수를 구성하여 변환한 다음 배치 프로세스를 시작할 수 있습니다.

PDF 문서 만들기

문서 조작

Communications document manipulation(Document Transformation) API 를 통해 PDF 문서를 결합하고 재배열할 수 있습니다. 일반적으로 DDX를 만들어 문서 조작 API에 제출하여 문서를 조합하거나 재정렬합니다. DDX 문서에서는 소스 문서를 사용하여 필요한 문서 세트를 생성하는 방법에 대한 지침을 제공합니다. DDX 참조 문서에서는 지원되는 모든 작업에 대한 자세한 정보를 제공합니다. 문서 조작 API의 몇 가지 예는 다음과 같습니다.

PDF 문서 어셈블

문서 조작 API를 사용하여 두 개 이상의 PDF 또는 XDP 문서를 단일 PDF 문서 또는 PDF 포트폴리오로 어셈블할 수 있습니다. 다음은 PDF 문서를 조합할 수 있는 몇 가지 방법입니다.

  • 간단한 PDF 문서 어셈블
  • PDF 포트폴리오 만들기
  • 암호화된 문서 어셈블
  • Bates 번호 매기기를 사용하여 문서 어셈블
  • 문서 변환 및 어셈블

여러 PDF 문서에서 간단한 PDF 어셈블하기
그림: 여러 PDF 문서에서 간단한 PDF 문서 어셈블하기

PDF 문서 디스어셈블

문서 조작 API를 사용하여 PDF 문서를 디스어셈블할 수 있습니다. API는 소스 문서에서 페이지를 추출하거나 책갈피를 기준으로 소스 문서를 나눌 수 있습니다. 일반적으로 이 작업은 명령문 컬렉션 등 여러 개별 문서에서 PDF 문서가 만들어진 경우에 유용합니다.

  • 소스 문서에서 페이지 추출
  • 책갈피를 기준으로 소스 문서 나누기

책갈피를 기준으로 소스 문서를 여러 문서로 나누기
그림: 책갈피를 기준으로 소스 문서를 여러 문서로 나누기

NOTE
AEM Forms은 PDF 파일과 원활하게 통합되는 다양한 기본 제공 글꼴을 제공합니다. 지원되는 글꼴 목록을 보려면 여기를 클릭하십시오.

문서 추출

문서 추출 기능은 얼리어답터 프로그램 아래에 있습니다. 공식 이메일 ID를 사용하여 aem-forms-ea@adobe.com으로 이메일을 보내 얼리 어답터 프로그램에 참여하고 기능에 대한 액세스 권한을 요청할 수 있습니다.

문서 추출 서비스는 사용 권한, PDF 속성 및 메타데이터와 같은 PDF 문서의 속성을 가져오는 기능을 제공합니다. 문서 추출 기능:

  • PDF에 첨부 파일, 댓글, Acrobat 버전 등이 있는 경우와 같은 PDF 문서의 속성을 가져옵니다.
  • PDF 문서에서 활성화된 사용 권한을 추출하면 사용자가 Adobe Acrobat Reader 확장성을 위해 PDF 문서에 대해 활성화 또는 비활성화된 사용 권한을 검색합니다.
  • PDF 문서에 있는 메타데이터 정보를 가져옵니다. 메타데이터는 텍스트 및 그래픽과 같은 문서의 컨텐츠와 구별되는 문서에 대한 정보입니다. Adobe XMP(Extensible Metadata Platform)은 문서 메타데이터를 처리하는 표준입니다. XMP 유틸리티 서비스는 PDF 문서에서 XMP 메타데이터를 검색하고 XMP 메타데이터를 PDF 문서로 내보낼 수 있습니다.

다음 API 참조 설명서 는 모든 매개 변수, 인증 방법 및 API에서 제공하는 서비스에 대한 자세한 정보를 제공합니다. API 참조 설명서는 .yaml 형식으로도 사용할 수 있습니다. .yaml 를 다운로드하고 Postman에 업로드하여 API의 기능을 확인할 수 있습니다.

문서 변환

PDF/A호환 문서로 변환하고 확인합니다.

커뮤니케이션 문서 변환 API 는 PDF 문서를 PDF/A로 변환하는 데 도움이 됩니다. API를 사용하여 PDF 문서를 PDF/A 호환 문서로 변환하고 PDF 문서가 PDF/A 호환 문서인지 확인할 수 있습니다. PDF/A는 문서 내용을 장기간 보존하기 위한 보관 형식입니다. 글꼴이 문서 내에 임베드되어 있고 파일이 압축 해제되어 있습니다. 따라서 PDF/A 문서는 일반적으로 표준 PDF 문서보다 큽니다. 또한 PDF/A 문서에는 오디오 및 비디오 콘텐츠가 포함되지 않습니다.

PDF을 XDP로 변환 convert-pdf-to-xdp

PDF을 XDP로 변환 기능은 얼리어답터 프로그램 아래에 있습니다. 공식 이메일 ID를 사용하여 aem-forms-ea@adobe.com으로 이메일을 보내 얼리 어답터 프로그램에 참여하고 기능에 대한 액세스 권한을 요청할 수 있습니다.

PDF 문서를 XDP 파일로 변환합니다. PDF 문서를 XDP 파일로 성공적으로 변환하려면 PDF 문서에 사전에 XFA 스트림이 있어야 합니다.

문서 보증 doc-assurance

DocAssurance 서비스에는 서명 및 암호화 API가 포함되어 있습니다.

서명 API

서명 API를 통해 조직에서 배포하고 수신하는 Adobe PDF 문서의 보안 및 개인정보를 보호할 수 있습니다. 보안 기능은 문서 자체에 적용되며, 문서는 전체 라이프 사이클에 대해 안전하게 제어됩니다. 문서는 오프라인으로 다운로드할 때와 조직에 다시 제출될 때 방화벽 이후에도 안전하게 유지됩니다. 서명 API를 사용하여 다음 작업을 수행할 수 있습니다.

  • PDF 문서에 보이는 서명 필드를 추가합니다.
  • PDF 문서에 보이지 않는 서명 필드를 추가합니다.
  • PDF 문서에서 지정된 서명 필드에 서명합니다.
  • PDF 문서 인증

암호화 API

암호화 API를 사용하면 문서를 암호화하고 해독할 수 있습니다. 문서가 암호화되면 해당 내용을 읽을 수 없게 됩니다. 인가된 사용자는 문서의 암호를 해독하여 콘텐츠에 액세스할 수 있습니다. PDF 문서가 암호로 암호화된 경우 Adobe Reader 또는 Adobe Acrobat에서 문서를 보려면 열기 암호를 지정해야 합니다.

암호화 API를 사용하여 다음 작업을 수행할 수 있습니다.

  • 암호로 PDF 문서를 암호화합니다.
  • PDF 문서에서 암호 기반 암호화를 제거합니다.
  • PDF 문서에 적용된 보안 유형을 검색합니다.
  • PDF 문서에 적용된 보안 유형을 반환합니다.

서명 API 및 암호화 API는 모두 동기 API.

문서 유틸리티 doc-utility

동기 API를 사용하는 문서 유틸리티를 사용하면 PDF 및 XDP 파일 형식 간에 문서를 변환할 수 있습니다. 문서에 사용 권한을 적용하고 문서에서 활성화된 사용 권한을 추출합니다. PDF 문서에 대한 쿼리 정보입니다. 사용 권한 API에 대한 세부 사항은 아래에 나와 있습니다.

사용 권한 API(Reader 확장)

사용 권한(Reader 확장) 기능은 얼리어답터 프로그램 아래에 있습니다. 공식 이메일 ID를 사용하여 aem-forms-ea@adobe.com으로 이메일을 보내 얼리 어답터 프로그램에 참여하고 기능에 대한 액세스 권한을 요청할 수 있습니다.

사용 권한 기능을 사용하면 추가 사용 권한과 함께 Adobe Reader의 기능을 확장하여 조직에서 대화형 PDF 문서를 쉽게 공유할 수 있습니다. 이 서비스는 Adobe Reader 7.0 이상에서 작동하며 PDF 문서에 사용 권한을 추가합니다. 이 작업은 문서에 주석 추가, 양식 채우기, 문서 저장과 같이 Adobe Reader을 사용하여 PDF 문서를 열 때 일반적으로 사용할 수 없는 기능을 활성화합니다.

PDF 문서에 적절한 사용 권한이 추가되면 수신자는 Adobe Reader 내에서 다음 활동을 수행할 수 있습니다.

  • 온라인과 오프라인에서 PDF 문서 및 양식을 작성합니다. 이를 통해 수신자는 레코드를 위해 사본을 로컬에 저장하고 추가된 정보는 그대로 유지할 수 있습니다.
  • PDF 문서를 로컬 하드 드라이브에 저장하여 원본 문서와 추가 설명, 데이터 또는 첨부 파일을 유지합니다.
  • PDF 문서에 파일 및 미디어 클립을 첨부합니다.
  • 업계 표준 공개 키 인프라(PKI) 기술을 사용하여 디지털 서명을 적용하여 PDF 문서에 서명, 인증 및 인증합니다.
  • 완료되거나 주석이 있는 PDF 문서를 전자적으로 제출합니다.
  • PDF 문서 및 양식을 내부 데이터베이스 및 웹 서비스에 대한 직관적인 개발 프런트 엔드로 사용합니다.
  • 검토자가 직관적인 마크업 도구를 사용하여 주석을 추가할 수 있도록 PDF 문서를 다른 사용자와 공유합니다. 이러한 도구에는 전자 스티커 메모, 스탬프, 하이라이트 및 텍스트 취소선이 포함됩니다. Acrobat에서도 동일한 기능을 사용할 수 있습니다.
  • Barcoded Forms 디코딩을 지원합니다.

이러한 특수 사용 권한 기능은 권한이 활성화된 PDF 문서가 Adobe Reader 내에서 열릴 때 자동으로 활성화됩니다. 사용자가 권한이 활성화된 문서 작업을 완료하면 Adobe Reader에서 해당 기능이 다시 비활성화됩니다. 사용자가 다른 권한이 활성화된 PDF 문서를 받을 때까지 비활성화됩니다.

사용 권한 활성화 또는 비활성화

PDF Reader 서비스를 확장하기 위한 다양한 사용 권한 기능은 다음과 같습니다.

  • 바코드 디코딩: PDF 문서 내의 바코드를 디코딩합니다.

  • 댓글: PDF 문서에 오프라인으로 댓글을 달습니다.

  • 댓글 온라인: PDF 문서에 온라인으로 주석을 답니다.

  • 디지털 서명: PDF 문서에 디지털 서명을 추가합니다.

  • 동적 양식 필드: PDF 문서에 양식 필드를 추가합니다.

  • 동적 양식 페이지: PDF 문서에 양식 페이지를 추가합니다.

  • 포함된 파일: PDF 문서 내에 파일을 포함합니다.

  • 양식 데이터 가져오기: 양식 데이터를 PDF 문서로 가져옵니다.

  • 양식 데이터 내보내기: 양식 데이터를 PDF 문서로 가져옵니다.

  • 양식 채우기: PDF 문서 내의 양식 필드를 채웁니다.

  • 온라인 Forms: PDF 문서에서 웹 서비스 또는 데이터베이스에 액세스합니다.

  • 독립 실행형 제출: PDF 문서에서 오프라인으로 양식 데이터를 제출합니다.

기타 기능

  • 메시지: 하나 이상의 사용 권한이 적용된 PDF 문서를 열 때 Adobe Acrobat Reader 내에 표시되는 메시지입니다.
  • 암호 잠금 해제: 암호화된 PDF 문서를 여는 데 필요한 암호입니다. 일반적으로 문서 열기 암호이지만 PDF 문서가 권한 암호로 추가로 보호되는 경우 중 하나를 사용하여 열 수 있습니다.

다음 API 참조 설명서 는 API에서 제공하는 모든 매개 변수, 인증 방법 및 다양한 서비스에 대한 자세한 정보를 제공합니다. API 참조 설명서는 .yaml 형식으로도 사용할 수 있습니다. .yaml 를 다운로드하고 Postman에 업로드하여 API의 기능을 확인할 수 있습니다.

통신 API 유형 types

커뮤니케이션은 주문형 및 배치 문서 생성에 HTTP API를 제공합니다.

  • 동기식 API ​는 주문형, 대기 시간이 낮은 단일 기록 문서 생성 시나리오에 적합합니다. 해당 API는 사용자 액션 기반 사용 사례에 보다 적합합니다. 예: 사용자 양식 작성 완료 후 문서 생성.

  • 배치 API(비동기 API) ​는 처리량이 높은 예약된 문서 생성 시나리오에 적합합니다. 해당 API는 배치 문서를 생성합니다. 예를 들어, 전화 요금 청구서, 신용카드 명세서 및 혜택 명세서는 매월 생성됩니다.

온보딩

커뮤니케이션 기능은 Forms as a Cloud Service 사용자용 독립 실행형 모듈과 추가 기능 모듈로 제공됩니다. Adobe 영업팀 또는 Adobe 담당자에게 문의하여 액세스 권한을 요청할 수 있습니다. Adobe는 조직에 대한 액세스 권한을 활성화하고 조직의 책임자로 지정된 사람에게 필요한 권한을 제공합니다. 관리자는 조직의 Forms as a Cloud Service 개발자(사용자)가 API를 사용할 수 있도록 액세스 권한을 부여할 수 있습니다.

온보딩 후 Forms as a Cloud Service 환경에 대한 통신 기능을 활성화하려면 다음을 수행하십시오.

  1. Cloud Manager에 로그인하고 AEM Forms as a Cloud Service 인스턴스를 엽니다.

  2. 프로그램 편집 옵션을 열고 솔루션 및 추가 기능 탭으로 이동하여 양식 - 커뮤니케이션 옵션을 선택합니다.

    커뮤니케이션

    양식 - 디지털 등록 옵션이 이미 활성화된 경우 양식 - 커뮤니케이션 추가 기능 옵션을 선택합니다.

    추가 기능

  3. 업데이트 ​를 클릭합니다.

  4. 빌드 파이프라인을 실행합니다. 빌드 파이프라인이 성공하면 환경에 통신 API가 활성화됩니다.

NOTE
문서 조작 API를 활성화하고 구성하려면 다음 규칙을 Dispatcher 구성:
# Allow Forms Doc Generation requests
/0062 { /type "allow" /method "POST" /url "/adobe/forms/assembler/*" }

추가 참조 see-also

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab