将文档和访问详细信息放在一起
- 声明服务
识别外部 API,并提供文档链接或文本。
- 单独访问详情
请提供用于连接所需的测试和生产凭据。
- 将业务背景关联起来
将现有连接与使用它的区域关联起来。
向集成提供它所需的信息
连接从服务名称和文档开始。解释需要它来执行哪个业务操作,以及应该在系统之间传递的信息。
该声明支持单独的测试和生产访问凭据。请在连接的详细信息页面上查看这些凭据,并确保明确环境上下文。
围绕其支持的业务操作进行集成。
请说明您需要兑换的内容. 外部服务可能提供或接收业务任务使用的信息。声明其名称和文档,然后解释在项目上下文中的预期交换。这使得集成具有超越服务 URL 的实际目的。
区分测试环境和生产环境. 测试凭证和生产凭证可以属于不同的提供商帐户。 将它们保存在相应的字段中,并验证其预期用途。 区分这些上下文有助于为集成的开发和上线阶段做好准备。
重复使用已声明的连接. 同一个外部服务可以支持多个业务领域。将其连接到相应的领域,然后检查其关联。将其从一个领域分离,以及从整个项目中删除它,是不同的决策。
在适当的位置重用连接
已声明的连接可以链接到多个业务领域。检查特定领域的链接连接,并附加或分离相应的服务。
配置服务可满足集成要求。在正式使用之前,请检查其状态并测试完整的业务流程。
请说明您的应用程序需要进行的兑换。
指定服务、要发送或接收的信息以及使用它的业务领域。指向当前文档的链接有助于描述实际的外部合同。
描述一个有用的示例,以及当服务不可用时预期的响应。然后,可以从用户工作流程的角度讨论连接问题,而不仅仅是提供商的名称。
从服务声明到经过测试的工作流程
提供服务信息. 提供文档链接或其内容以及所需的访问详细信息。说明需要连接的业务操作。
将正确的区域关联起来. 将声明的连接附加到使用它的区域。在添加或删除连接之前,请查看现有的关联。
验证完成的集成. 跟踪其状态,并在相关环境中测试预期的交互。仅声明并不能证明工作流程是否正常运行。
关于外部连接的问题
请提供外部服务名称以及文档链接或粘贴内容。提供测试环境和生产环境所需的访问凭据。仅提供名称无法定义集成的行为。
现有的连接可以与多个业务领域关联。查看连接器详细信息中关联的领域,以便了解其范围。
外部连接描述了您的应用程序如何使用另一项服务。可选的项目 API 公开了您的应用程序的约定操作。它们满足不同的集成需求。
断开连接器是指将其与某个区域的连接解除。从项目中删除连接器是另一项操作,范围不同;请在继续操作前查看确认信息。
执行并测试完整的业务流程。已声明的服务及其激活状态是有用的上下文信息,但不应取代对结果的验证。