将 Square 与 IBM App Connect Enterprise 配合使用

Square 是一个支付平台，面向中小型公司，使其能够接收信用卡支付，并使用平板电脑作为销售点系统的支付日志。 IBM® App Connect Enterprise 提供了 Square Request 节点，您可以使用此节点连接到 Square ，并发出请求以对对象 (例如，批量变更库存，客户，订单，发票，付款和退款) 执行操作。

1. 在 IBM App Connect Enterprise Toolkit中，创建包含 Square Request 节点的流。
2. 选择流中的 Square Request 节点以在编辑器中显示节点属性。
3. 在 基本 选项卡上，单击 启动连接器发现。
   此时会显示一个面板，您可以在其中指定要在连接器发现期间使用的策略项目名称和保险库文件详细信息。
4. 指定要在连接器发现期间使用的策略项目和保险库文件的详细信息：
   1. 在 策略项目 字段中，指定用于存储连接器发现期间创建的策略的策略项目。
      也可以通过单击新建并指定新策略项目的名称来创建新的策略项目。 然后单击完成。
   2. 指定要在连接器发现期间使用的保险库文件。 缺省情况下，连接器发现期间使用的凭证存储在 外部目录保险库中，这是可供任何集成服务器使用的 App Connect Enterprise 保险库文件。 或者，您可以将凭证存储在集成服务器保险库文件中，该保险库文件是在集成服务器的工作目录中创建的，并且只能由该特定集成服务器使用。
      要指定用于存储凭证的保险库文件，请完成下列其中一个主题的 使用连接器发现向导 部分中的步骤:

      • 配置外部目录保险库
      • 配置集成服务器保险库
   3. 在 保险库密钥 字段中，输入用于访问保险库中存储的凭证的保险库密钥。 保险库密钥的长度必须至少为 8 个字符。
   4. 可选: 缺省情况下，指定的保险库文件位置和保险库文件密钥将另存为 Toolkit 中的首选项，以便在您启动 "连接器发现" 时预设这些值。 如果您不希望保存这些首选项，请取消选中保存在保险库文件首选项中。
5. 单击 启动发现 以启动 Square 连接器的 "连接器发现" 向导。
   此时将显示 " 连接器发现 " 窗口。 如果现有 Square 连接 (帐户) 可用，那么将显示这些连接的列表。 如果没有现有连接，那么 Square 连接器的状态将显示为 Not connected。
   • 如果一个或多个 Square 连接 (帐户) 可用，请完成以下步骤:
     1. 通过单击要使用的连接 (帐户) 来选择该连接。
     2. 单击所需的对象类型，然后选择要对该对象执行的操作。 例如，要从 Square检索客户，请单击 客户 ，然后单击 检索客户。
   • 如果没有现有连接（帐户），请完成以下步骤：
     1. 单击所需的对象类型，然后选择要对该对象执行的操作。 例如，要从 Square检索客户，请单击 客户 ，然后单击 检索客户。
     2. 单击 连接 以显示一个菜单，您必须从该菜单中选择下列其中一种授权方法:
        • 提供凭证以供 App Connect 使用 (API KEY)
        • 提供凭证以供 App Connect 使用 (BASIC OAUTH)
     3. 如果选择了 提供凭证以供 App Connect 使用 (API KEY) 作为授权方法，请输入以下详细信息:
        1. 在端点 URL 字段中，输入用于验证 Square 实例的 URL。 例如，在沙盒环境中，端点 URL 是 connect.squareupsandbox.com ，而在生产平台中，端点 URL 是 connect.squareupsandbox.com 。
        2. 在 个人访问令牌 字段中，输入在 Square中应用程序的凭证部分下生成的生产访问令牌或沙箱访问令牌。
     4. 如果选择了 提供凭证以供 App Connect 使用 (BASIC OAUTH) 作为授权方法，请输入以下详细信息:
        1. 在端点 URL 字段中，输入用于验证 Square 实例的 URL。 例如，在沙盒环境中，端点 URL 是 connect.squareupsandbox.com ，而在生产平台中，端点 URL 是 connect.squareupsandbox.com 。
        2. 在 客户机标识 字段中，输入在 Square中应用程序的 OAuth 部分下生成的生产应用程序标识或沙箱应用程序标识。
        3. 在 访问令牌 字段中，输入从应用程序客户机标识和客户机密钥生成的访问令牌。
        4. 在 刷新令牌 字段中，输入从应用程序客户机标识和客户机密钥生成的刷新令牌。
        5. 在重定向 URI 字段中，输入 Square 将在验证后重定向浏览器的 URI URL ）。

        有关访问或生成这些连接详细信息的更多信息，请参阅 如何使用 IBM App Connect 和 Square 文档中的 IBM App Connect Enterprise as a Service 。

     5. 单击连接。
6. 在向导中设置必需的连接器属性。
   对于检索或更新操作，您可以通过单击 添加条件 ，然后选择要过滤的属性来添加用于检索数据的条件。

   如果为检索或更新操作添加条件，那么可以选择使用条件过滤来优化应用的条件。 要使用条件过滤，请通过单击 "关闭" 按钮 (X) 退出 "连接器发现" 向导，然后完成 使用条件过滤中的指示信息。

   对于创建操作，可以选择使用高级方式。 在操作的缺省编辑视图中，某些应用程序具有隐藏的字段，因为一般用例不需要这些字段。 对于更高级的用例，您可以切换到高级方式编辑，这将为编辑流提供额外的功能。 要使用高级方式，请通过单击 "关闭" 按钮 (X) 退出 "连接器发现" 向导，然后完成 使用高级方式中的指示信息。

   您还可以设置一些属性，这些属性指定要检索的最大记录数以及在超过该限制时要执行的操作。

7. 在 "连接器发现" 向导中指定完属性后，单击 保存。
   用于连接到 Square 的凭证存储在保险库文件中，其他连接详细信息保存在 Square 策略中。 有关更多信息，请参阅 Square 策略。 您在向导中设置的属性值将返回到 IBM App Connect Enterprise Toolkit中的 Square Request 节点。
8. 完成发现并保存属性值后，通过单击窗口右上角的 X 或按 Alt+F4来退出 "连接器发现" 向导。
9. 返回到编辑 IBM App Connect Enterprise Toolkit中的 Square Request 节点。
   现在，在 "连接器发现" 向导 (在步骤 6中) 中设置的连接器属性在属性编辑器中的 Square Request 节点上可视。 基本 选项卡显示您在向导中设置的 操作 和 对象 属性的值。 例如，如果在向导中选择了 客户 > 检索客户 ，那么将在节点的 基本 选项卡上显示以下属性:

   • 操作 - RETRIEVEALL
   • 对象 - customers

   操作和对象属性的值将以只读格式显示。 如果要更改这些值，您可以通过再次单击启动连接器发现并在“连接器发现”向导中设置新值来执行此操作。

   模式基本名称 属性指定模式文件的基本名称，这些文件描述发送至 Square 连接器以及从该连接器接收的请求和响应消息的格式。 模式基本名称是在您第一次为节点运行发现时自动设置的，它基于当前流名称和节点名。 如果在首次运行发现之前手动设置此属性，那么将使用您设置的值。 如果在发现后重命名模式，那么必须编辑此属性，以使其与项目中重命名的模式所使用的模式基本名称相匹配。 如果在发现后更改此属性，那么必须重命名模式名称以匹配或再次运行发现。

   根据发现期间选择的操作， "连接器发现" 向导将生成请求模式和响应模式，或者仅生成响应模式。 仅当所选操作和对象需要请求消息时，才会生成请求模式。 生成的请求模式用于验证请求消息。 如果操作为 RETRIEVE 或 DELETE，那么连接器仅返回响应模式。

   生成的模式文件将添加到项目中，并且可供 映射 节点用于变换输入或输出数据。 模式的完整文件名派生自模式基本名称 (例如 gen/MyMessageFlow.Square_Request) ，后缀为 response.schema.json 或 request.schema.json。 您可以通过单击 打开请求模式 或 打开响应模式来打开模式。

10. 检查 Square Request 节点上的属性设置是否正确，然后保存消息流。
11. 在 Square Request 节点的 连接 选项卡上， 策略 属性显示策略的名称，该策略包含要用于连接的安全身份的详细信息。 策略的类型为 Square。
    有关更多信息，请参阅 Square 策略。
12. 可选: 在 连接 选项卡上设置 超时 属性，以指定节点等待 Square 处理操作的时间 (以秒计)。
13. 平方请求 节点的 过滤器 选项卡包含一些属性，这些属性用于控制消息流选择数据的方式。 这些属性的初始值取自在 "连接器发现" 向导中为 Square 连接器设置的属性值，包括过滤器选项属性和指定的任何条件 (如步骤 6中所述)。 如果您随后返回到 "连接器发现" 向导并更改任何属性的值 (例如，通过添加新条件) ，那么这些更新将反映在节点上设置的属性中。

    过滤器选项 属性控制执行 Square Request 节点时要对哪些对象进行操作。 过滤器限制 属性控制要检索的最大项数以及超出限制时要执行的操作。

    您可以通过单击要在 " 过滤器选项 " 部分中修改的值旁边的 编辑 ，并通过更改已在 过滤器限制 部分中设置的属性值来修改值。

    属性值可以是文本值，也可以是 ESQL 或 XPATH 表达式，这些表达式根据执行时传递到 Square Request 节点的消息内容进行解析。

14. 在 请求 选项卡上，设置 数据位置 属性以指定入局消息树中包含要在 正方形中创建的对象数据的位置。 此数据构成从 Square Request 节点发送到 Square的请求。
15. 在 结果 选项卡上，设置 输出数据位置 属性以指定输出消息树中将包含在 正方形中创建的记录数据的位置。
16. 缺省情况下，将根据连接器发现期间生成的请求模式验证请求消息。 您可以通过使用 Square Request 节点的 Validation 属性来关闭请求验证或更改验证设置。
17. 保存 消息流。