适用于 Adobe Commerce 的 Adobe Acrobat Sign:用户指南

概述

适用于 Adobe Commerce 的 Adobe Acrobat Sign 扩展可自动执行签名工作流程,并将其与现有电子商务交易集成。通过在结帐过程中访问自动签名工作流程,用户可以快速、流畅地进行电子商务采购。适用于 Adobe Commerce 的 Acrobat Sign 可以简化采购协议、保修协议、服务合同、条款和条件同意书等文档审批流程。Adobe Acrobat Sign 扩展是一个免费工具,需要企业级 Adobe Acrobat Sign Solutions 协议才能使用。

适用于 Adobe Commerce 的 Adobe Acrobat Sign:用户指南提供了有关如何使用 Adobe Acrobat Sign 扩展配置 Adobe Commerce 以创建要在您的网站中使用的协议的说明。要使用适用于 Adobe Commerce 的 Acrobat Sign 在您的网站内创建协议,您必须完成以下步骤:

  1. 验证前提条件
  2. 创建 Acrobat Sign 开发人员帐户
  3. 配置 Adobe Commerce 应用程序以进行 OAuth 身份验证
  4. 配置 Acrobat Sign
  5. 为 Acrobat Sign 实施高级设置
  6. (可选)在 Adobe Commerce 中配置 Document Generation API
  7. (可选)将 .docx 模板上传到模板库
  8. 使用网站测试配置
注意:

系统将根据您购买的 Acrobat Sign 权限计算使用适用于 Adobe Commerce 的 Adobe Acrobat Sign 发送的协议的数量。

要了解如何根据权限对 Acrobat Sign 事务进行计数和计费,请参阅您的 Adobe Acrobat Sign 帐户中的事务使用情况

先决条件

要成功使用适用于 Adobe Commerce 的 Acrobat Sign,您必须确保系统满足以下要求:

创建 Acrobat Sign 开发人员帐户

在 Adobe Commerce 上安装 Acrobat Sign 扩展后,您必须创建一个 Adobe Acrobat Sign 开发人员帐户,通过该帐户链接应用程序。要执行此操作,请转到 Acrobat Sign 开发人员门户创建一个开发人员帐户。

您需要使用提供 OAuth 身份验证的专用 Acrobat Sign 帐户以及用来收发协议的电子邮件。Acrobat Sign 帐户创建者或管理员可将用户添加到帐户并根据需要创建组。请参阅 Adobe Acrobat Sign 用户指南以了解如何开始使用 Adobe Acrobat Sign。 了解如何 为管理员和用户设置授权级别

配置 Adobe Commerce 应用程序以进行 OAuth 身份验证

要配置 Adobe Commerce 应用程序,您需要执行以下操作:

要创建 Acrobat Sign API,请执行以下操作:

  1. 转到 Adobe Acrobat Sign 登录页面,然后使用您的管理员凭据登录。

    此时将显示主仪表板,如下所示。 

    sign-dashboard

  2. 从顶部菜单中,选择帐户

  3. 从左侧面板中,选择 Acrobat Sign API 可打开下拉菜单,然后选择 API 应用程序

    sign-api-applications

  4. 在“API 应用程序”页面的右上角,选择以创建新的 API 应用程序。

  5. 在打开的对话框中,按如下所示填写必填字段:

    • 名称显示名称下,为应用程序提供一个唯一名称并显示名称。
    • 下,选择客户
      请参阅 Acrobat Sign 开发人员指南以了解有关如何创建应用程序的详细信息。
    • 选择保存以完成该过程。此时会打开“API 应用程序”页面。
    sign-create-api

  6. 从 API 应用程序列表中,选择您在上述步骤中创建的应用程序,然后选择为应用程序配置 OAuth

    sign-config-oauth

  7. 在出现的“配置 OAuth”对话框中:

    1. 提供重定向 URI 的值。该值是“Adobe 刷新令牌帮助程序”页的 URL。
      要获取 URL,请转到 Adobe Commerce 管理员页面并登录。然后,从左侧面板中,选择系统 > 刷新令牌帮助程序(在 Adobe Acrobat Sign 下)。  接下来,复制页面 URL,返回到“配置 OAuth”对话框,并将其粘贴到重定向 URL 字段。
    2. 根据需要启用该复选框。请参考下图了解所需的最低设置。
    3. 选择保存

    您应该限制站点上用户的权限范围,并根据业务需要设置权限。例如:scope=agreement_read:self+agreement_write:self+agreement_send:self

    下图显示了使 Adobe Acrobat Sign 扩展能够与 Adobe Commerce 网站一起使用以达成手机服务协议所需的最低权限,在本文档中将其用作示例。

    sign-config-oauth-details-new1

    sign-oauth-settings-new1

  8. 要获取 Acrobat Sign 客户端 ID 和客户端密钥凭据,请执行以下操作:

    1. 在“API 应用程序”页面上,选择您在上述步骤中创建的应用程序以将其突出显示。
    2. 选择查看/编辑。 在打开的查看对话框中,应用程序ID字段显示客户端ID,值字段显示客户端密钥。
    3. 复制客户端 ID 和客户端密钥对应的值,并将其保存,以在使用刷新令牌帮助程序进行身份验证时使用。

    注意:您也可以从“配置 OAuth”对话框获取客户端 ID。

    sign-view-edit

    sign-view-id-value

Adobe Commerce 提供了刷新令牌帮助程序以帮助 Acrobat Sign 扩展进行 OAuth 身份验证。刷新令牌帮助程序提供了在 Acrobat Sign 中创建应用程序所需的重定向 URL。使用重定向 URL 在 Acrobat Sign 中创建应用程序后,该应用程序将提供 OAuth 身份验证所需的 Acrobat Sign 客户端 ID 和客户端密钥。

要使用刷新令牌帮助程序对 Acrobat Sign 进行身份验证,请执行以下操作:

  1. 转到 Adobe Commerce 管理员页面,然后使用您的管理员凭据登录。

  2. 从左侧导航菜单中,选择系统 > 刷新令牌帮助程序(在 Adobe Acrobat Sign 下)。

  3. 在打开的“刷新令牌帮助程序”页面中,按如下所示填写必填字段:

    • 客户端环境:要查找客户端环境,请登录到 Acrobat Sign 并检查 URL。环境标识符可在 URL 地址中找到,它就位于 echosign.com(adobesign.com)部分的前面。有关详细信息,请参阅此处
    • 范围:它表示授予 Acrobat Sign 应用程序的权限,并以键值对的形式指定。在“范围”字段中,添加以下字符串:
      scope=agreement_read:self+agreement_write:self+agreement_send:self
    • 客户端 ID客户端密钥:填写您在创建 Acrobat Sign 应用程序 API 时获取的客户端 ID 和客户端密钥值。
    • 重定向 URL:这是“Adobe 刷新令牌帮助程序”页的 URL。将重定向 URL 复制到剪贴板,因为您需要在 Acrobat Sign 帐户中对其进行配置。
    注意:

    对于管理员,刷新令牌帮助程序信息是使集成正常工作所需的默认最小范围。商店所有者不需要更改刷新令牌帮助程序信息。

    magento-refresh-token-helper

  4. 选择发送

    此时会显示一条消息,确认已将您的凭据添加到 Adobe Acrobat Sign 配置页面,如下图所示。

    现在,您可以在 Adobe Commerce 中配置 Acrobat Sign 扩展。

    new-refresh-token-helper-result

配置 Acrobat Sign

要在 Adobe Commerce 中配置 Acrobat Sign 应用程序,您需要:

请按照以下步骤对 Acrobat Sign API 进行身份验证:

  1. 转到 Adobe Commerce 应用程序并使用您的用户凭据登录。

  2. 在左侧菜单中,选择商店 > 配置

    magento-store-config

  3. 在出现的“配置”页面上,从左侧面板中,选择 Adobe Document Cloud > Adobe Acrobat Sign

  4. 选择 Adobe Acrobat Sign 配置选项卡以将其展开。

    注意:

    如果使用刷新令牌帮助程序,则会为您预填充 Acrobat Sign 凭据。

    magento-configuration

    注意:要配置 Acrobat Sign 扩展,您必须对扩展进行身份验证并建立商店网站内各个类别对应的特定协议的要求标准。您可以单独自定义每个商店网站的协议,但是,Acrobat Sign 扩展的身份验证方法在您的所有商店中保持一致。

  5. 验证详细信息并选择保存配置

    现已针对 OAuth 身份验证对 Acrobat Sign 扩展进行了配置。

您可以使用预定义的电子邮件模板,或上传您自己使用预定义变量进行自定义的模板。

了解如何自定义电子邮件模板

了解如何将预定义的变量添加到电子邮件模板

请按照以下步骤配置 Adobe Commerce 提供的预定义模板:

  1. 转到 Adobe Commerce 应用程序并使用您的用户凭据登录。

  2. 从左侧菜单中,选择营销 > 电子邮件模板

    magento-email-template

  3. 在出现的“电子邮件模板”页面中,选择添加新模板

    magento-add-template

  4. 在打开的“新建模板”页面中,打开模板下拉菜单,然后选择其中一个可用模板。

    注意:如果需要,您可以从头开始创建模板,而不是使用可用模板。

    magento-blank-template

  5. 选择加载模板

    它使用包含预配置类的 HTML 元素填充模板内容字段,如下图所示。如需自定义商店内特定类别的模板,您可以使用 HTML 标签编辑模板内容。

    magento-new-template

  6. 模板名称字段中,提供一个简洁而确切的名称。

    注意:模板名称将是在 Acrobat Sign 中创建的协议的名称。

  7. 模板主题字段中,添加描述以反映该模板的特定用例。

  8. 要将变量添加到模板,请选择插入变量,然后从由 Adobe Commerce 应用程序预配置的变量列表中选择变量。

    您选择的所有变量都将添加到“模板内容”字段中。 

    注意:变量根据应用模板的上下文提供动态信息,如商店信息和网站 URL。 有关详细信息,请参阅 电子邮件模板变量

    magento-insert-variable

  9. 完成后,选择保存模板

    新模板即会显示在营销电子邮件模板列表中。

您可以使用 Acrobat Sign 扩展来自定义各个商店和类别所需的协议。您可以通过此功能完全控制协议收件人的角色、您需要对其进行的身份验证,以及根据产品类别应使用的模板。

请按照以下步骤自定义 Acrobat Sign 协议设置:

  1. 转到 Adobe Commerce 应用程序并使用您的用户凭据登录。

  2. 在左侧菜单中,选择商店 > 配置

  3. 在出现的“配置”页面上,从左侧面板中,选择 Adobe Document Cloud > Adobe Acrobat Sign

  4. 选择 Adobe Acrobat Sign 协议设置选项卡以将其展开。

    magento-sign-agreement-setttings

  5. Adobe Acrobat Sign 协议设置下,填写必填字段,如下所示:

    • 协议发件人电子邮件字段下,提供用于创建 Acrobat Sign 帐户的电子邮件地址。该电子邮件作为发件人电子邮件变量存储,并显示在您选择包含该电子邮件的任何模板中。您必须拥有专用的 Acrobat Sign 帐户以及用于收发协议的电子邮件。
    • 参与者角色字段下,选择以下四个可用选项之一:
      • 签名者(默认角色):它需要至少一个来自收件人的签名,并且可供所有 Adobe Acrobat Sign 客户使用。
      • 审批者:适用于所有小型企业和企业 Acrobat Sign 客户。审批者不需要签署任何字段或与任何字段交互(除非强制要求),只需要在将文档发送给签名者之前审阅文档并输入自己的姓名。
      • 接受者:适用于企业 Acrobat Sign 客户。接受者通常需要在未正式批准内容的情况下确认并接受协议。
      • 经过认证的收件人:系统不会为经过认证的收件人分配表单字段,可能会要求他们将表单委派给指定的人员来决定/拒绝终止协议,或者确认协议以继续签名流程。

                要了解详细信息,请参阅有关收件人角色的 Adobe 帮助文档。

    注意:

    已配置的参与者角色和身份验证方法会自动应用于所有协议、商店和产品。

    magento-participant-roles

    • 签名者身份验证方法字段下,请选择以下身份验证方法之一:
      • 无:如果您不需要对签名者进行任何身份验证,则可以选择此选项。
      • 密码:这要求参与者先输入两次密码,然后才能查看协议。 密码由Adobe Commerce管理员提供,该管理员配置扩展的Acrobat Sign设置。 相同的密码适用于所有协议。
      • KBA:这是一种高级身份验证方法,仅限美国境内的收件人使用。
        此方法主要用于银行业务。收件人必须回答与其个人信息相关的问题,这些信息是从公共数据库中获取的。
      • Adobe Acrobat Sign:收件人需要先使用 Acrobat Sign 系统进行身份验证,然后才能查看协议。此方法通常适用于发送协议的同一 Acrobat Sign 帐户中的用户。
      • 政府 ID:它要求收件人提供政府签发的文档的副本,如驾照、护照等。

    有关详细信息,请参阅 Adobe Acrobat Sign 身份验证方法

    magento-authentication-modes

    • 管理协议下拉字段下,从该商店的可用产品类别列表中选择以前配置的商店。

      注意:Acrobat Sign 协议设置将模板与产品类别相关联。这样,每个已配置的店面就可以针对各种产品类别采用不同的协议。该商店的可用产品类别填充在“管理协议”下拉列表下。

    • 要将特定模板应用于您网站中的类别或产品,请选择相应字段旁边的 (+) 图标,然后从出现的下拉列表中选择模板。

      注意:模板系统分层次结构。通过为默认类别选择模板,所有子类别都需要同意应用该模板。如果父类别和子类别所选模板不同,则由于范围级别,后者优先。 默认情况下不应用模板;仅应用于管理协议部分中类别的模板。
    注意:

    无法删除与产品关联的 docx 模板(以 * 标记表示),因为这些模板正在使用中。要删除与产品关联的模板,您必须首先将该模板与 Acrobat Sign 部分下的产品类别取消关联。 

  6. 选择保存配置

Acrobat Sign 实施高级设置

按照以下步骤为 Acrobat Sign 实施高级设置:

  1. 转到 Adobe Commerce 应用程序并使用您的用户凭据登录。

    magento-login

  2. 在左侧菜单中,选择商店 > 配置

  3. 在出现的“配置”页面上,从左侧面板中,选择 Adobe Document Cloud > Adobe Acrobat Sign。接下来,选择 Adobe Acrobat Sign 高级设置选项卡以将其展开。

    magento_configuration

  4. Adobe Acrobat Sign 高级设置下,根据需要修改以下两个字段:

    • JSON 有效负载:它是发送到 API 的原始 JSON。它以公开代码的形式提供,以便高级用户能够在紧急时刻进行灵活调整。无法从配置设置 UI 进行配置。

    注意:每当 Adobe Acrobat Sign 扩展的配置发生更改时,系统都会重新生成 JSON 有效负载。您直接对 JSON 有效负载所做的任何更改将被覆盖。

    • JSON 示例数据:它是一个示例有效负载,并突出显示了用户可能在模板中使用的所有变量。这适用于电子邮件模板和 Document Generation API 模板。 例如,以下电子邮件模板示例在JSON示例数据中显示变量地址行。 这使开发人员可以准确地了解他们可以在模板中使用哪些变量。

        "address": {

            "address_id": "862",

            "address_type": "shipping",

            "applied_taxes": "[]",

            "base_customer_balance_amount": "0.0000",

            "base_discount_amount": "0.0000",

            "base_discount_tax_compensation_amount": "0.0000",

            "base_gift_cards_amount": "0.0000",

            "base_grand_total": "33.0000",

            "base_reward_currency_amount": "0.0000",

            "base_shipping_amount": "5.0000",

            "base_shipping_discount_amount": "0.0000",

            "base_shipping_discount_tax_compensation_amnt": null,

            "base_shipping_incl_tax": "5.0000",

            "base_shipping_tax_amount": "0.0000",

            "base_subtotal": "28.0000",

            "base_subtotal_total_incl_tax": "28.0000",

            "base_subtotal_with_discount": "28.0000",

            "base_tax_amount": "0.0000",

            "city": "bellevue",

            "collect_shipping_rates": "0",

            "company": null,

            "country_id": "US",

            "created_at": "2022-07-26 20:31:27",

            "customer_address_id": "14",

            "customer_balance_amount": "0.0000",

            "customer_id": "28",

            "customer_notes": null,

            "discount_amount": "0.0000",

            "discount_description": null,

            "discount_tax_compensation_amount": "0.0000",

            "email": "jeremy@ensemble.com",

            "entity_id": "862",

            "fax": null,

            "firstname": "Jeremy",

            "free_shipping": "0",

            "gift_cards": "[]",

            "gift_cards_amount": "0.0000",

            "gift_message_id": null,

            "giftregistry_item_id": null,

            "grand_total": "33.0000",

            "gw_add_card": null,

            "gw_allow_gift_receipt": null,

            "gw_base_price": "0.0000",

            "gw_base_price_incl_tax": null,

            "gw_base_tax_amount": null,

            "gw_card_base_price": "0.0000",

            "gw_card_base_price_incl_tax": null,

            "gw_card_base_tax_amount": null,

            "gw_card_price": "0.0000",

            "gw_card_price_incl_tax": null,

            "gw_card_tax_amount": null,

            "gw_id": null,

            "gw_items_base_price": "0.0000",

            "gw_items_base_price_incl_tax": null,

            "gw_items_base_tax_amount": null,

            "gw_items_price": "0.0000",

            "gw_items_price_incl_tax": null,

            "gw_items_tax_amount": null,

            "gw_price": "0.0000",

            "gw_price_incl_tax": null,

            "gw_tax_amount": null,

            "lastname": "Liao",

            "middlename": null,

            "postcode": "90210",

            "prefix": null,

            "quote_id": "243",

            "region": "Washington",

            "region_id": "62",

            "reward_currency_amount": "0.0000",

            "reward_points_balance": "0",

            "same_as_billing": "0",

            "save_in_address_book": "0",

            "shipping_amount": "5.0000",

            "shipping_description": "Flat Rate - Fixed",

            "shipping_discount_amount": "0.0000",

            "shipping_discount_tax_compensation_amount": "0.0000",

            "shipping_incl_tax": "5.0000",

            "shipping_method": "flatrate_flatrate",

            "shipping_tax_amount": "0.0000",

            "street": "123 4th avenue",

            "subtotal": "28.0000",

            "subtotal_incl_tax": "28.0000",

            "subtotal_with_discount": "28.0000",

            "suffix": null,

            "tax_amount": "0.0000",

            "telephone": "555-555-5555",

            "updated_at": "2022-07-26 21:10:36",

            "used_gift_cards": "[]",

            "validated_country_code": null,

            "validated_vat_number": null,

            "vat_id": null,

            "vat_is_valid": null,

            "vat_request_date": null,

            "vat_request_id": null,

            "vat_request_success": null,

            "weight": "1.0000"

        },

        "quote": {

            "agreement_id": null,

            "agreements_signed": "0",

            "applied_rule_ids": null,

            "base_currency_code": "USD",

            "base_customer_bal_amount_used": "0.0000",

            "base_gift_cards_amount": "0.0000",

            "base_gift_cards_amount_used": "0.0000",

            "base_grand_total": "33.0000",

            "base_reward_currency_amount": "0.0000",

            "base_subtotal": "28.0000",

            "base_subtotal_with_discount": "28.0000",

            "base_to_global_rate": "1.0000",

            "base_to_quote_rate": "1.0000",

            "checkout_method": null,

            "converted_at": null,

            "coupon_code": null,

            "created_at": "2022-07-26 20:31:27",

            "customer_balance_amount_used": "0.0000",

            "customer_dob": null,

            "customer_email": "jeremy@ensemble.com",

            "customer_firstname": "Jeremy",

            "customer_gender": null,

            "customer_group_id": "1",

            "customer_id": "28",

            "customer_is_guest": "0",

            "customer_lastname": "Liao",

            "customer_middlename": null,

            "customer_note": null,

            "customer_note_notify": "1",

            "customer_prefix": null,

            "customer_suffix": null,

            "customer_tax_class_id": "3",

            "customer_taxvat": null,

            "entity_id": "243",

            "event_initialized": true,

            "ext_shipping_info": null,

            "extension_attributes": {},

            "gift_cards": null,

            "gift_cards_amount": "0.0000",

            "gift_cards_amount_used": "0.0000",

            "gift_message_id": null,

            "global_currency_code": "USD",

            "grand_total": "33.0000",

            "gw_add_card": null,

            "gw_allow_gift_receipt": null,

            "gw_base_price": "0.0000",

            "gw_base_price_incl_tax": null,

            "gw_base_tax_amount": null,

            "gw_card_base_price": "0.0000",

            "gw_card_base_price_incl_tax": null,

            "gw_card_base_tax_amount": null,

            "gw_card_price": "0.0000",

            "gw_card_price_incl_tax": null,

            "gw_card_tax_amount": null,

            "gw_id": null,

            "gw_items_base_price": "0.0000",

            "gw_items_base_price_incl_tax": null,

            "gw_items_base_tax_amount": null,

            "gw_items_price": "0.0000",

            "gw_items_price_incl_tax": null,

            "gw_items_tax_amount": null,

            "gw_price": "0.0000",

            "gw_price_incl_tax": null,

            "gw_tax_amount": null,

            "is_active": "1",

            "is_changed": "1",

            "is_multi_shipping": "0",

            "is_persistent": "0",

            "is_virtual": "0",

            "item_name": "Caesar Warm-Up Pant",

            "item_price": "28.00",

            "item_qty": 1,

            "item_subtotal": "28.00",

            "item_summary": "1 x Caesar Warm-Up Pant",

            "items": [

                {}

            ],

            "items_count": "1",

            "items_qty": "1.0000",

            "orig_order_id": "0",

            "password_hash": null,

            "quote_currency_code": "USD",

            "remote_ip": "207.6.51.28",

            "required_agreements": null,

            "reserved_order_id": null,

            "reward_currency_amount": "0.0000",

            "reward_points_balance": "0",

            "sign_status": null,

            "sign_url": null,

            "store_currency_code": "USD",

            "store_id": "1",

            "store_to_base_rate": "0.0000",

            "store_to_quote_rate": "0.0000",

            "subtotal": "28.0000",

            "subtotal_with_discount": "28.0000",

            "trigger_recollect": "0",

            "updated_at": "2022-07-26 21:01:27",

            "use_customer_balance": null,

            "use_reward_points": null

        }

    }

  5. 选择保存配置

    这样即实施了已修改的 Acrobat Sign 高级设置。

在 Adobe Commerce 中配置 Document Generation API

要使用 Document Generation API 创建协议,您必须首先按如下步骤配置 Document Generation API 的身份验证设置:

  1. 转到 Adobe Commerce 应用程序并使用您的用户凭据登录。

  2. 在左侧菜单中,选择商店 > 配置

  3. 在显示的“配置”页面,从左侧面板中选择 Adobe Document Cloud > Adobe Document Generation

    注意:Adobe Document Generation 选项卡提供了另一种创建协议的方法。您可以直接在“模板库”部分上传 .docx 模板,而不是使用 Adobe Commerce 的现有电子邮件模板。

    注意:

    无法删除与产品关联的 docx 模板(以 * 标记表示),因为这些模板正在使用中。要删除与产品关联的模板,您必须首先将该模板与 Acrobat Sign 部分下的产品类别取消关联。 

  4. 选择身份验证模板库可展开这两个分区,如下所示。 
    您需要填写必填字段,才能使用Document Generation API服务进行身份验证。

    magento doc generation

  5. 要获取所需字段的凭据,请导航至 Adobe Developer Console

    注意:要使用 Document Generation API,您必须拥有一个有效的 PDF Services API 许可证。 
    您必须创建一个新项目才能获得Adobe Commerce的凭据,才能使用OAuth对Document Generation API进行身份验证。 

  6. 在顶部菜单中,选择项目选项卡。接下来,选择新建项目 > 清空项目

    dev console create project

  7. 在新项目仪表板中,选择添加 API

    dev-console-add-api

  8. 在出现的添加 API 对话框中,选择 Document Cloud > PDF Services API。然后,选择下一步

    dev-console-pdf-service-api

  9. 要生成 JWT 公钥和私钥对,请选择选项 1然后选择生成密钥对

    此时会显示一个弹出窗口,确认已生成密钥对,如下所示。 

    dev-console-generate-key-pair

    dev-console-keypair-generated

  10. 检查下载文件夹,找到包含私钥的配置文件。使用文本编辑器打开此配置文件并复制私钥。

    注意:切勿丢失此私钥,因为 Adobe 没有保留副本。

    config-api-private-key

  11. 转到 Adobe Commerce 应用程序页面,然后导航至商店 > Adobe Document Cloud > Adobe Document Generation。然后,在身份验证下,选中选择文件(“上传私钥”旁边),并选择上面步骤中下载的配置文件。

    magento doc generation

  12. 返回到 Adobe Developer Console Configure API 对话框,然后选择下一步

    dev-console-keypair-generated

  13. 从列表中选择 Enterprise PDF Service Developer 产品配置文件,然后选择保存配置的 API

    此时系统会显示一条弹出消息,确认您的 API 已配置成功。现在可从项目主页获取 Document Generation API 所需的其余凭据。

    config-api-enterprise-save

  14. 在左侧面板中,选择服务帐户 (JWT)。

    dev-console-generate-jwt

  15. 从“凭据详细信息”选项卡中复制其余所需的详细信息,并将其粘贴到 Adobe Commerce 中的 Document Generation API 常规设置页面中。

    dev-console-service-account-details

  16. 选择生成 JWT 并复制 JWT 有效负载。

    Document Generation API 使用 JWT 令牌进行身份验证。

    dev-console-generate-jwt-aud-value

  17. 转到“常规配置”页面,将 JWT 有效负载粘贴到相应的字段中。 

  18. 选择保存配置

    Document Generation API 访问点是从 JWT 有效负载中获取的 URL。将“aud”值从 https:// 复制到 .com/,然后将该 URL 粘贴到 Adobe Commerce UI 的 API 访问点字段中。

    现在,Adobe Commerce 应用程序中已配置了 Document Generation API。有关更多信息,请参阅 Document Service API 帮助

将 .docx 模板上传到模板库

您可以通过“模板库”分区来使用 .docx 文件上传定制模板。您可以使用 .docx 文件中的任何纯文本,并且文本可由 Document Generator API 进行编译。但是,只有 JSON 示例数据中包含的值才能在 .docx 文件中使用。

通过 .docx 模板上传的模板格式必须写在双大括号内,如下例所示。

客户:{{customer_firstname}} {{customer_lastname}}

货币:{{store_currency_code}}

要通过浏览本地文件导入文档模板,请执行以下操作:

  1. 在 Adobe Commerce 应用程序中,选择商店 > 配置

  2. 在出现的“配置”页面,从左侧面板中选择 Adobe Document Cloud > Adobe Document Generation

    注意:

    要了解如何在 Microsoft Word 中安装和使用 Adobe Document Generation,请参阅 Word 插件的开发人员指南

  3. 在“上传模板”旁边,选中选择文件并选择要上传的文件。接下来,选择上传模板以完成该过程。

    注意:仅支持 .docx 文件类型。

    注意:

    无法删除与产品关联的 docx 模板(以 * 标记表示),因为这些模板正在使用中。要删除与产品关联的模板,您必须首先将该模板与以下位置的协议取消关联:商店 > 配置 > Adobe Acrobat Sign > Adobe Acrobat Sign 协议设置 > 管理协议下面。

    magento-template-library

  4. 上传浏览器显示了可用模板文档的平面层次结构,如下图所示。

    您可以使用该 UI 通过删除未使用的库模板来管理您的模板库。之前上传的模板可通过以下方式删除:从下拉列表中选择要删除的模板,然后选择“删除模板”。对于当前正在使用的任何模板,其文件名旁边都标有星号。

    现在,此配置的效果会反映在您的网站中。

    magento-config-upload-browser

使用网站测试配置

为了测试扩展配置,我们以从 Luma 商店购买了手机并签署服务合同作为该协议的一部分进行示例。

按照以下步骤使用您的网站测试配置:

  1. 导航至您的商店网站并使用您的帐户凭据登录。 

    注意:最终用户必须登录才能完成此过程。如果客户未登录且未提供姓名,则他们将被重定向到创建帐户或登录页面,如下所示。

    test-config-2

    test-config-3-new

  2. 要查看适用的协议,请选择查看协议。

    test-checkout-1

  3. 要打开“Adobe Acrobat Sign 协议”对话框,请选择查看并签名

    “Adobe Acrobat Sign 协议”对话框会显示在 Adobe Commerce 控制面板的“签名协议设置”中配置的服务协议模板。客户的信息已预填充到文档中。

    test-checkout-2

  4. 要签署协议,用户必须选择高亮显示的字段或下一步指示符。

  5. 在出现的“签名”对话框中,使用四种可用方法之一添加签名,然后选择应用

    test-checkout-3

  6. 对于需要多个签名或缩写签名的协议,请选择下一个必填字段以循环显示相关输入字段。

  7. 签署协议后,选择应用以完成该过程。

  8. 然后,“Adobe Acrobat Sign 协议”对话框需要收件人确认条款和条件。选择单击以签名

    test-config-8-new

    此时会显示一条确认消息,说明协议流程已完成,如下所示。 签名者还会通过电子邮件收到已签名的协议副本。 

    用户现在可以继续进行结帐过程以完成交易。

    test-checkout-4

Adobe, Inc.

更快、更轻松地获得帮助

新用户?