可选项目 API

在需要时公开商定的应用程序操作。

审核符合条件的项目 API 范围,区分计划中的路径和已构建的端点。

将 API 视为一个已定义的项目选项

查看选项

请检查 API 的可用性和相应的项目方案。

定义路线范围

明确 API 应该提供的业务功能。

检查路线目录

查看每条路线的路径、状态以及计划或实际状态。

当您的项目需要时,添加一个 API

该项目的 API 是可选功能。在启用之前,请查看其范围和条款,不要假定每个应用程序都包含该功能。

API 工具按业务领域组织建议的路线。说明有助于在实施之前定义每个操作应该做什么。

区分预期的路线和实际的终点

为其他系统准备访问权限. 一个项目可能需要另一个应用程序来使用其业务操作。请查看可选的 API 范围并提供,而不是假设每个函数都会自动公开。约定的操作定义了集成应该访问的内容。

查看路线目录. 该目录显示每个路由的方法、路径、描述和状态。它可以帮助区分建议的范围与已注册为活跃的端点。这是在遵循 API 准备过程时的一个实用参考。

选择正确的集成方向. 使用其他提供商的 API 和公开您自己的应用程序是不同的需求。外部连接适用于前者;项目 API 适用于约定的公开。选择与您想要的业务交流相符的方案。

区分公开的 API 和外部连接

项目 API 公开您的应用程序中约定的操作。外部连接描述了您的应用程序如何使用另一项服务;它们满足不同的需求。

使用路由目录检查方法、路径,以及某个端点是否已计划或已上线。此演示不会为您的项目激活 API。

根据具体需求评估 API 选项

确定将使用项目数据的对象以及集成需要哪些操作。这有助于区分可选的 API 范围和与现有外部服务的连接。

对于符合条件的项目,请检查计划路线及其施工状态。在确认相关服务和环境后,再确定是否可以将某个端点提供给集成。

从可选范围到已验证的曝光

查看可用性和条款. 请查看实际项目报价中的 API 选项。在激活之前,确定该应用程序是否需要该功能。

说明操作步骤. 审核拟议的业务流程,并回答有关其预期行为的问题。 遵循准备和构建阶段。

查看当前直播. 检查已激活项目的路线目录和已发布的参考资料。计划路线不是一个可用的终端。

在添加 API 之前,先确定集成范围。

解释另一个系统需要的功能,并审查该选项的条件。API应服务于双方商定的业务需求。

有关可选项目 API 的问题

这是一个选项,其可用性和价格显示在实际的报价中。应用程序可以在不激活它的情况下运行。此演示不提供或启用您的项目的 API。

它描述了一个预期的操作,该操作尚未注册为可用的端点。在开始集成之前,请使用目录状态和实际发布的参考。

该项目 API 视图显示了要公开的领域、问题、基础设施和构建状态。解决所陈述的先决条件,并检查生成的路由目录。

使用已激活项目和相关环境中的 API 参考文档。不要仅从计划的路由中推断端点或身份验证示例。

它们描述了您的应用程序使用的另一个服务。这种集成方式与通过项目 API 公开您自己的应用程序操作的方式不同。