Passer au contenu principal
Procore

Que dois-je savoir sur l'obsolescence de l'API Vapid ?

Contexte

Depuis le 1er février 2021, l'API Vapid de Procore est devenu obsolète et a été remplacée par la nouvelle API Rest v1.0. La nouvelle API est basée sur une architecture mise à jour qui prend en charge la gestion des versions des ressources et des fonctionnalités étendues. Bien que Procore continuera à prendre en charge les ressources de l'API Vapid et à corriger les défauts selon les besoins, tous les développements de nouvelles fonctionnalités pour l'API Procore seront effectués dans Rest v1.0. Bien qu'il soit peu probable que ce changement ait un impact sur la plupart des clients Procore, si vous développez et maintenez des intégrations personnalisées à l'aide de l'API, nous vous encourageons à consulter cet article pour en savoir plus sur la façon dont ce changement pourrait affecter votre intégration ainsi que les étapes de migration vers la nouvelle API Rest. v1.0.

Questions courantes

En quoi Rest v1.0 diffère-t-il de Vapid ?

Rest v1.0 est un sur-ensemble de l'API Vapid. Tous les points de terminaison de ressources disponibles dans Vapid sont également disponibles dans Rest v1.0 avec la même fonctionnalité.

Y a-t-il de nouvelles ressources auxquelles je peux accéder ?

Surveillez les notifications du portail des développeurs Procore annonçant la sortie de nouvelles ressources de l'API Rest.

Y a-t-il des changements importants dans Rest v1.0 dont je dois tenir compte ?

Rest v1.0 ne contient aucun changement de rupture. La mise à niveau d'une application pour utiliser Rest v1.0 nécessite simplement de modifier les routes que vous demandez (par exemple, /vapid/projects devient /rest/v1.0/projects).

Y a-t-il des changements dans la façon dont l'authentification est gérée ?

Non. Le point de terminaison d'authentification (ex. /oauth/authorize) reste le même dans Rest et les jetons d'authentification sont partagés entre les deux API.

Comment migrer mon code d'application vers Rest v1.0 ?

Mettre à niveau une application qui utilise actuellement l'API Vapid pour utiliser Rest v1.0 est aussi simple que de changer les routes que vous demandez. Mettez à jour votre intégration pour utiliser les ressources Rest v1.0 en modifiant le format des URL de point de terminaison d'API dans votre code pour utiliser le nouvel espace de noms (/rest) et le paramètre de version (v1.0) comme indiqué dans l'exemple ci-dessous.

/api.procore.com/vapid/projects

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

Nous vous recommandons de tester votre code mis à jour dans votre sandbox de développement pour vérifier que votre intégration fonctionnera correctement à l'aide des points de terminaison de ressource /rest/v1.0.

Nouvelle documentation du développeur de l'API Rest v1.0

Toute la documentation destinée aux développeurs sur le portail des développeurs a été mise à jour avec la sortie de Rest v1.0. Des pages de référence pour les ressources de l'API Rest v1.0 sont disponibles dans la section RÉFÉRENCE du portail. Utilisez le menu déroulant et sélectionnez Rest v1 pour accéder au nouveau contenu de référence.

ref-guide-picker.png

De plus, tous les guides de développement d'API, didacticiels et documents connexes dans la section DOCS du portail ont été mis à jour avec la sortie de Rest v1.0. Tous les extraits de code et exemples ont été mis à jour pour refléter le nouveau format d'URL de point de terminaison.

Gestion des versions des ressources de l'API Rest

La nouvelle architecture de gestion des versions de l'API Rest permet une approche flexible de la gestion des versions, car les ressources sont versionnées indépendamment les unes des autres. Cela vous permet de choisir si vous souhaitez adopter de nouvelles versions de ressources (avec des modifications importantes) ou conserver celles que vous utilisez actuellement. Utilisez les nouvelles versions des ressources au fur et à mesure qu'elles sont publiées et mettez à jour votre code en conséquence, ou attendez que cela ait plus de sens pour votre calendrier de développement particulier. Voir Présentation de l'API Rest pour plus d'informations.

Journal des modifications de l'API de repos

La nouvelle fonctionnalité de journal des modifications, également disponible sur le portail des développeurs, vous permet d'afficher les détails des modifications apportées aux ressources d'API individuelles. Voir Présentation de l'API Rest pour plus d'informations.