Vapid API の廃止について知っておくべきことは何ですか?
背景
2021 年２月１日の時点で、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 でも使用できます。
アクセスできる新しいリソースはありますか?
新しい Rest API リソースのリリースを発表する Procore 開発者ポータルからの通知に注目してください。
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 リソースの参照ページは、ポータルの [REFERENCE] セクションにあります。ドロップダウン メニューを使用して [Rest v1] を選択し、新しい参照コンテンツにアクセスします。
さらに、ポータルの [DOCS] セクションにあるすべての API 開発ガイド、チュートリアル、および関連資料は、Rest v1.0 のリリースで更新されました。新しいエンドポイント URL 形式を反映するために、すべてのコード スニペットとサンプルが更新されました。
REST API リソースのバージョン管理
新しい Rest API バージョン管理アーキテクチャでは、リソースが互いに独立してバージョン管理されるため、バージョン管理への柔軟なアプローチが可能になります。これにより、新しいリソース バージョン (重大な変更を含む) を採用するか、現在使用しているバージョンをそのまま使用するかを選択できます。新しいリソース バージョンがリリースされたらそれを使用し、それに応じてコードを更新するか、特定の開発タイムラインにとってより意味のあるものになるまで待ちます。詳細については、「Rest API の概要」を参照してください。
REST API 変更記録
新しい変更記録機能は、開発者ポータルでも利用でき、個々の API リソースに対する変更の詳細を表示できます。詳細については、「Rest API の概要」を参照してください。