跳转到主内容
Procore

关于 Vapid API 的弃用,我需要了解什么?

背景

自 2021 年 2 月 1 日起,Procore 的 Vapid API 已被弃用,取而代之的是新的 Rest API v1.0。新 API 基于支持资源版本控制和扩展功能的更新架构。尽管 Procore 将继续支持 Vapid API 资源并会根据需要解决缺陷问题,但 Procore API 的所有新功能开发都将在 Rest v1.0 中完成。虽然此更改不太可能影响大多数 Procore 客户,但如果你使用 API 开发和维护自定义集成,则我们鼓励你查看本文,以了解有关此更改可能如何影响你的集成以及迁移到新 Rest API v1.0 的步骤的更多信息。

常见问题

Rest v1.0 与 Vapid 有何不同?

Rest v1.0 是 Vapid API 的超集。Vapid 中可用的所有资源端点在 Rest v1.0 中也可用并且功能相同。

是否有我可以访问的新资源?

敬请留意 Procore 开发人员门户关于发布新 Rest API 资源的通知。

Rest v1.0 中是否有我需要关注的重大更改?

Rest v1.0 不包含重大更改。将应用程序升级为使用 Rest v1.0 只需要更改请求的路由即可(例如,/vapid/projects 变为 /rest/v1.0/projects)。

身份验证的处理方式是否有任何变化?

否。身份验证端点(例如 /oauth/authorize)在 Rest 中保持不变,并且身份验证令牌在两个 API 之间共享。

如何将我的应用程序代码迁移到 Rest v1.0?

将当前使用 Vapid API 的应用程序升级为使用 Rest v1.0 就像更改请求的路由一样简单。通过更改代码中 API 端点 URL 的格式以使用新的命名空间 (/rest) 和版本参数 (v1.0),即可让你的集成改为使用 Rest v1.0 资源,如以下示例所示。

/api.procore.com/vapid/projects

/api.procore.com/rest/v1.0/projects

我们建议在开发沙箱中测试更新的代码,以验证集成是否可以使用 /rest/v1.0 资源端点正常运行。

新 Rest v1.0 API 开发人员文档

开发人员门户上的所有开发人员文档都已随着 Rest v1.0 的发布而更新。门户的参考资料部分提供 Rest v1.0 API 资源的参考资料页面。使用下拉菜单并选择 Rest v1 以访问新的参考内容。

ref-guide-picker.png

此外,门户的文档部分中的所有 API 开发指南、教程和相关材料都已随着 Rest v1.0 的发布而更新。所有代码片段和示例都已更新,以反映新的端点 URL 格式。

Rest API 资源版本控制

新的 Rest API 版本控制架构提供了一种灵活的版本管理方法,因为资源的版本控制彼此独立。这让你可以选择是要采用新的资源版本(具有重大更改),还是继续使用当前的版本。你可以使用发布的新资源版本并相应地更新代码,或者等到新版本对你的特定开发时间线而言更有意义时再使用。有关更多信息,请参阅 Rest API 概述

Rest API 变更日志

开发人员门户还提供新的变更日志功能,允许你查看有关单个 API 资源变更的详细信息。有关更多信息,请参阅 Rest API 概述