使用同步处理

Formsas a Cloud Service — 通信API允许您创建、组合和提供面向品牌的个性化通信,如业务信函、文档、报表、理赔处理信函、福利通知、理赔处理信函、每月账单和欢迎资料包。 您可以使用通信API将模板(XFA或PDF)与客户数据结合,以PDF、PS、PCL、DPL、IPL和ZPL格式生成文档。

假设您有一个或多个模板以及每个模板的多个XML数据记录。 您可以使用通信API为每个记录生成打印文档。 结果会生成一个非交互式PDF文档。 非交互式PDF文档不允许用户在其字段中输入数据。

Formsas a Cloud Service — 通信为计划文档生成提供了按需API和批量API(异步API):

  • 同步API适用于按需、低延迟和单记录文档生成用例。 这些API更适合基于用户操作的用例。 例如,在用户填写表单后生成文档。

  • 批处理API(异步API)适用于计划的高吞吐量多文档生成用例。 这些API可批量生成文档。 例如,每月生成的电话账单、信用卡报表和福利报表。

使用同步操作

同步操作是以线性方式生成文档的过程。 这些API被分类为单租户API和多租户API:

单租户API

  • 文档生成API
  • 文档操作API

验证单租户API

单租户API操作支持两种类型的身份验证:

(仅限文档生成API)配置资产和权限

要使用同步API,需要满足以下条件:

  • 具有Experience Manager管理员权限的用户
  • 将模板和其他资产上传到Experience Manager FormsCloud Service实例

(仅适用于文档生成API)将模板和其他资产上传到Experience Manager实例

组织通常具有多个模板。 例如,信用卡报表、福利报表和索赔申请各有一个模板。 将所有此类XDP和PDF模板上传到Experience Manager实例。 要上传模板,请执行以下操作:

  1. 打开Experience Manager实例。
  2. 转到Forms > Forms和文档
  3. 单击创建>文件夹,然后创建文件夹。 打开该文件夹。
  4. 单击创建>文件上传,然后上传模板。

调用API

API参考文档 提供有关API提供的所有参数、身份验证方法和各种服务的详细信息。 API引用文档还提供了.yaml格式的API定义文件。 您可以下载.yaml文件并将其上传到 Postman 来检查API的功能。

注意

只有表单用户组的成员才能访问通信API。

在此页面上